Aws::Transfer::Model::DescribeAccessRequest Class Reference

#include <DescribeAccessRequest.h>

Inheritance diagram for Aws::Transfer::Model::DescribeAccessRequest:

Public Member Functions

AWS_TRANSFER_API DescribeAccessRequest ()=default

 

virtual const char * GetServiceRequestName () const override

 

AWS_TRANSFER_API Aws::String SerializePayload () const override

 

AWS_TRANSFER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override

 

const Aws::String & GetServerId () const

 

bool ServerIdHasBeenSet () const

 

template<typename ServerIdT = Aws::String>

void SetServerId (ServerIdT &&value)

 

template<typename ServerIdT = Aws::String>

DescribeAccessRequest & WithServerId (ServerIdT &&value)

 

const Aws::String & GetExternalId () const

 

bool ExternalIdHasBeenSet () const

 

template<typename ExternalIdT = Aws::String>

void SetExternalId (ExternalIdT &&value)

 

template<typename ExternalIdT = Aws::String>

DescribeAccessRequest & WithExternalId (ExternalIdT &&value)

 

Public Member Functions inherited from Aws::Transfer::TransferRequest

virtual ~TransferRequest ()

 

void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const

 

Aws::Http::HeaderValueCollection GetHeaders () const override

 

Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest

 AmazonSerializableWebServiceRequest ()

 

virtual ~AmazonSerializableWebServiceRequest ()

 

std::shared_ptr< Aws::IOStream > GetBody () const override

 

Public Member Functions inherited from Aws::AmazonWebServiceRequest

 AmazonWebServiceRequest ()

 

virtual ~AmazonWebServiceRequest ()=default

 

virtual const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

 

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

 

virtual void AddQueryStringParameters (Aws::Http::URI &uri) const

 

virtual void PutToPresignedUrl (Aws::Http::URI &uri) const

 

virtual bool IsStreaming () const

 

virtual bool IsEventStreamRequest () const

 

virtual bool HasEventStreamResponse () const

 

virtual bool SignBody () const

 

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) const

 

virtual bool IsChunked () const

 

virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)

 

virtual const RequestSignedHandler & GetRequestSignedHandler () const

 

const Aws::IOStreamFactory & GetResponseStreamFactory () const

 

void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

 

virtual const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

 

virtual const Aws::Http::DataReceivedEventHandler & GetDataReceivedEventHandler () const

 

virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const

 

virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const

 

virtual const RequestRetryHandler & GetRequestRetryHandler () const

 

virtual bool ShouldComputeContentMd5 () const

 

virtual bool ShouldValidateResponseChecksum () const

 

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

 

virtual Aws::String GetChecksumAlgorithmName () const

 

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

 

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

 

virtual EndpointParameters GetEndpointContextParams () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

 

void AddUserAgentFeature (Aws::Client::UserAgentFeature feature) const

 

Aws::Set< Aws::Client::UserAgentFeature > GetUserAgentFeatures () const

 

virtual bool RequestChecksumRequired () const

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

Additional Inherited Members

Public Types inherited from Aws::Transfer::TransferRequest

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

typedef Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters

 

Protected Member Functions inherited from Aws::AmazonWebServiceRequest

virtual void DumpBodyToUrl (Aws::Http::URI &uri) const

 

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Definition at line 21 of file DescribeAccessRequest.h.

Constructor & Destructor Documentation

DescribeAccessRequest()

AWS_TRANSFER_API Aws::Transfer::Model::DescribeAccessRequest::DescribeAccessRequest ( )

default

Member Function Documentation

ExternalIdHasBeenSet()

bool Aws::Transfer::Model::DescribeAccessRequest::ExternalIdHasBeenSet ( ) const

inline

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 "<i>YourGroupName</i>*"} -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: =,.@:/-

Definition at line 65 of file DescribeAccessRequest.h.

GetExternalId()

const Aws::String & Aws::Transfer::Model::DescribeAccessRequest::GetExternalId ( ) const

inline

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 "<i>YourGroupName</i>*"} -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: =,.@:/-

Definition at line 64 of file DescribeAccessRequest.h.

GetRequestSpecificHeaders()

AWS_TRANSFER_API Aws::Http::HeaderValueCollection Aws::Transfer::Model::DescribeAccessRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::Transfer::TransferRequest.

GetServerId()

const Aws::String & Aws::Transfer::Model::DescribeAccessRequest::GetServerId ( ) const

inline

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

Definition at line 42 of file DescribeAccessRequest.h.

GetServiceRequestName()

virtual const char * Aws::Transfer::Model::DescribeAccessRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file DescribeAccessRequest.h.

SerializePayload()

AWS_TRANSFER_API Aws::String Aws::Transfer::Model::DescribeAccessRequest::SerializePayload ( ) const

overridevirtual

Implements Aws::AmazonSerializableWebServiceRequest.

ServerIdHasBeenSet()

bool Aws::Transfer::Model::DescribeAccessRequest::ServerIdHasBeenSet ( ) const

inline

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

Definition at line 43 of file DescribeAccessRequest.h.

SetExternalId()

template<typename ExternalIdT = Aws::String>

void Aws::Transfer::Model::DescribeAccessRequest::SetExternalId ( ExternalIdT &&  value)

inline

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 "<i>YourGroupName</i>*"} -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: =,.@:/-

Definition at line 67 of file DescribeAccessRequest.h.

SetServerId()

template<typename ServerIdT = Aws::String>

void Aws::Transfer::Model::DescribeAccessRequest::SetServerId ( ServerIdT &&  value)

inline

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

Definition at line 45 of file DescribeAccessRequest.h.

WithExternalId()

template<typename ExternalIdT = Aws::String>

DescribeAccessRequest & Aws::Transfer::Model::DescribeAccessRequest::WithExternalId ( ExternalIdT &&  value)

inline

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 "<i>YourGroupName</i>*"} -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: =,.@:/-

Definition at line 69 of file DescribeAccessRequest.h.

WithServerId()

template<typename ServerIdT = Aws::String>

DescribeAccessRequest & Aws::Transfer::Model::DescribeAccessRequest::WithServerId ( ServerIdT &&  value)

inline

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

Definition at line 47 of file DescribeAccessRequest.h.

---

The documentation for this class was generated from the following file:

• generated/src/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeAccessRequest.h