ListWebApps - AWS Transfer Family
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

ListWebApps

Lists all web apps associated with your AWS account for your current region. The response includes the endpoint type for each web app, showing whether it is publicly accessible or VPC hosted.

For more information about using VPC endpoints with AWS Transfer Family, see Create a Transfer Family web app in a VPC.

Request Syntax

{
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

The maximum number of items to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

Returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional web apps.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 6144.

Required: No

Response Syntax

{
   "NextToken": "string",
   "WebApps": [ 
      { 
         "AccessEndpoint": "string",
         "Arn": "string",
         "EndpointType": "string",
         "WebAppEndpoint": "string",
         "WebAppId": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

Provide this value for the NextToken parameter in a subsequent command to continue listing additional web apps.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 6144.

WebApps

Returns, for each listed web app, a structure that contains details for the web app.

Type: Array of ListedWebApp objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

This exception is thrown when an error occurs in the AWS Transfer Family service.

HTTP Status Code: 500

InvalidNextTokenException

The NextToken parameter that was passed is invalid.

HTTP Status Code: 400

InvalidRequestException

This exception is thrown when the client submits a malformed request.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: