Lists all web apps associated with your Amazon Web Services 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 Transfer Family, see Create a Transfer Family web app in a VPC.
Parameters:
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of items to return.
-
next_token
(Optional[NextToken], default:
None
)
–
Returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional web apps.
Raises:
Source code in docs_src/capo_transfer/_services/transfer.py
| def list_web_apps(
self,
*,
config_overrides: Optional[TransferClientConfig] = None,
max_results: Optional["capo_transfer.types.max_results.MaxResults"] = None,
next_token: Optional["capo_transfer.types.next_token.NextToken"] = None,
) -> "capo_transfer.types.list_web_apps_response.ListWebAppsResponse":
"""<p>Lists all web apps associated with your Amazon Web Services account for your current region. The response includes the endpoint type for each web app, showing whether it is publicly accessible or VPC hosted.</p> <p>For more information about using VPC endpoints with Transfer Family, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/create-webapp-in-vpc.html">Create a Transfer Family web app in a VPC</a>.</p>
Args:
max_results: <p>The maximum number of items to return.</p>
next_token: <p>Returns the <code>NextToken</code> parameter in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional web apps.</p>
Raises:
capo_transfer.errors.internal_service_error.InternalServiceError: <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
capo_transfer.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The <code>NextToken</code> parameter that was passed is invalid.</p>
capo_transfer.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
capo_transfer.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_transfer.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_transfer.types.list_web_apps_request.ListWebAppsRequest]",
) -> OperationResponse[
"capo_transfer.types.list_web_apps_response.ListWebAppsResponse"
]:
import capo_transfer._operations.transfer_service.list_web_apps
output, http_response = (
capo_transfer._operations.transfer_service.list_web_apps.list_web_apps(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListWebApps")
)
input_: capo_transfer.types.list_web_apps_request.ListWebAppsRequest = {}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|