Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateWebApp

Assigns new properties to a web app. You can modify the access point, identity provider details, endpoint configuration, and the web app units.

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

Request Syntax


{
   "AccessEndpoint": "string",
   "EndpointDetails": { ... },
   "IdentityProviderDetails": { ... },
   "WebAppId": "string",
   "WebAppUnits": { ... }
}

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.

AccessEndpoint

The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.

Type: String

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

Required: No

EndpointDetails

The updated endpoint configuration for the web app. You can modify the endpoint type and VPC configuration settings.

Type: UpdateWebAppEndpointDetails object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

IdentityProviderDetails

Provide updated identity provider values in a WebAppIdentityProviderDetails object.

Type: UpdateWebAppIdentityProviderDetails object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

WebAppId

Provide the identifier of the web app that you are updating.

Type: String

Length Constraints: Fixed length of 24.

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

Required: Yes

WebAppUnits

A union that contains the value for number of concurrent connections or the user sessions on your web app.

Type: WebAppUnits object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

Response Syntax


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

WebAppId

Returns the unique identifier for the web app being updated.

Type: String

Length Constraints: Fixed length of 24.

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

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

ConflictException

This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.

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