AWS SDK for C++  1.9.104
AWS SDK for C++
Public Member Functions | List of all members
Aws::Transfer::Model::DescribeAccessRequest Class Reference

#include <DescribeAccessRequest.h>

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

Public Member Functions

 DescribeAccessRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetServerId () const
 
bool ServerIdHasBeenSet () const
 
void SetServerId (const Aws::String &value)
 
void SetServerId (Aws::String &&value)
 
void SetServerId (const char *value)
 
DescribeAccessRequestWithServerId (const Aws::String &value)
 
DescribeAccessRequestWithServerId (Aws::String &&value)
 
DescribeAccessRequestWithServerId (const char *value)
 
const Aws::StringGetExternalId () const
 
bool ExternalIdHasBeenSet () const
 
void SetExternalId (const Aws::String &value)
 
void SetExternalId (Aws::String &&value)
 
void SetExternalId (const char *value)
 
DescribeAccessRequestWithExternalId (const Aws::String &value)
 
DescribeAccessRequestWithExternalId (Aws::String &&value)
 
DescribeAccessRequestWithExternalId (const char *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::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
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 SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 21 of file DescribeAccessRequest.h.

Constructor & Destructor Documentation

◆ DescribeAccessRequest()

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

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

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

Definition at line 99 of file DescribeAccessRequest.h.

◆ GetRequestSpecificHeaders()

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 41 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::String Aws::Transfer::Model::DescribeAccessRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

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 47 of file DescribeAccessRequest.h.

◆ SetExternalId() [1/3]

void Aws::Transfer::Model::DescribeAccessRequest::SetExternalId ( Aws::String &&  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 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 "<i>YourGroupName</i>*"} -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: =,.@:/-

Definition at line 144 of file DescribeAccessRequest.h.

◆ SetExternalId() [2/3]

void Aws::Transfer::Model::DescribeAccessRequest::SetExternalId ( const Aws::String 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 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 "<i>YourGroupName</i>*"} -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: =,.@:/-

Definition at line 129 of file DescribeAccessRequest.h.

◆ SetExternalId() [3/3]

void Aws::Transfer::Model::DescribeAccessRequest::SetExternalId ( const char *  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 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 "<i>YourGroupName</i>*"} -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: =,.@:/-

Definition at line 159 of file DescribeAccessRequest.h.

◆ SetServerId() [1/3]

void Aws::Transfer::Model::DescribeAccessRequest::SetServerId ( Aws::String &&  value)
inline

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

Definition at line 59 of file DescribeAccessRequest.h.

◆ SetServerId() [2/3]

void Aws::Transfer::Model::DescribeAccessRequest::SetServerId ( const Aws::String value)
inline

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

Definition at line 53 of file DescribeAccessRequest.h.

◆ SetServerId() [3/3]

void Aws::Transfer::Model::DescribeAccessRequest::SetServerId ( const char *  value)
inline

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

Definition at line 65 of file DescribeAccessRequest.h.

◆ WithExternalId() [1/3]

DescribeAccessRequest& Aws::Transfer::Model::DescribeAccessRequest::WithExternalId ( Aws::String &&  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 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 "<i>YourGroupName</i>*"} -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: =,.@:/-

Definition at line 189 of file DescribeAccessRequest.h.

◆ WithExternalId() [2/3]

DescribeAccessRequest& Aws::Transfer::Model::DescribeAccessRequest::WithExternalId ( const Aws::String 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 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 "<i>YourGroupName</i>*"} -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: =,.@:/-

Definition at line 174 of file DescribeAccessRequest.h.

◆ WithExternalId() [3/3]

DescribeAccessRequest& Aws::Transfer::Model::DescribeAccessRequest::WithExternalId ( const char *  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 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 "<i>YourGroupName</i>*"} -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: =,.@:/-

Definition at line 204 of file DescribeAccessRequest.h.

◆ WithServerId() [1/3]

DescribeAccessRequest& Aws::Transfer::Model::DescribeAccessRequest::WithServerId ( Aws::String &&  value)
inline

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

Definition at line 77 of file DescribeAccessRequest.h.

◆ WithServerId() [2/3]

DescribeAccessRequest& Aws::Transfer::Model::DescribeAccessRequest::WithServerId ( const Aws::String value)
inline

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

Definition at line 71 of file DescribeAccessRequest.h.

◆ WithServerId() [3/3]

DescribeAccessRequest& Aws::Transfer::Model::DescribeAccessRequest::WithServerId ( const char *  value)
inline

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

Definition at line 83 of file DescribeAccessRequest.h.


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