CreateWebApp
Creates a web app based on specified parameters, and returns the ID for the new web app.
Request Syntax
{
"AccessEndpoint": "string
",
"IdentityProviderDetails": { ... },
"Tags": [
{
"Key": "string
",
"Value": "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.Before you enter a custom URL for this parameter, follow the steps described in Update your access endpoint with a custom URL.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- IdentityProviderDetails
-
You can provide a structure that contains the details for the identity provider to use with your web app.
For more details about this parameter, see Configure your identity provider for Transfer Family web apps.
Type: WebAppIdentityProviderDetails object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- Tags
-
Key-value pairs that can be used to group and search for web apps.
Type: Array of Tag objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: No
- 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 a unique identifier for the web app.
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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: