Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeWebApp

Describes the web app that's identified by WebAppId. The response includes endpoint configuration details such as whether the web app 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


{
   "WebAppId": "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.

WebAppId

Provide the unique identifier for the web app.

Type: String

Length Constraints: Fixed length of 24.

Pattern: webapp-[0-9a-f]{17}

Required: Yes

Response Syntax


{
   "WebApp": { 
      "AccessEndpoint": "string",
      "Arn": "string",
      "DescribedEndpointDetails": { ... },
      "DescribedIdentityProviderDetails": { ... },
      "EndpointType": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "WebAppEndpoint": "string",
      "WebAppEndpointPolicy": "string",
      "WebAppId": "string",
      "WebAppUnits": { ... }
   }
}

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.

WebApp

Returns a structure that contains the details of the web app.

Type: DescribedWebApp object

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServiceError

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

HTTP Status Code: 500

InvalidRequestException

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

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when a resource is not found by the AWSTransfer Family service.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400