Transfer / Client / update_web_app

update_web_app

Transfer.Client.update_web_app(**kwargs)

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 Transfer Family, see Create a Transfer Family web app in a VPC.

See also: AWS API Documentation

Request Syntax

response = client.update_web_app(
    WebAppId='string',
    IdentityProviderDetails={
        'IdentityCenterConfig': {
            'Role': 'string'
        }
    },
    AccessEndpoint='string',
    WebAppUnits={
        'Provisioned': 123
    },
    EndpointDetails={
        'Vpc': {
            'SubnetIds': [
                'string',
            ]
        }
    }
)
Parameters:

  • WebAppId (string) –

    [REQUIRED]

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

  • IdentityProviderDetails (dict) –

    Provide updated identity provider values in a WebAppIdentityProviderDetails object.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: IdentityCenterConfig.

    • IdentityCenterConfig (dict) –

      A structure that describes the values to use for the IAM Identity Center settings when you update a web app.

      • Role (string) –

        The IAM role used to access IAM Identity Center.

  • AccessEndpoint (string) – 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.

  • WebAppUnits (dict) –

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

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: Provisioned.

    • Provisioned (integer) –

      An integer that represents the number of units for your desired number of concurrent connections, or the number of user sessions on your web app at the same time.

      Each increment allows an additional 250 concurrent sessions: a value of 1 sets the number of concurrent sessions to 250; 2 sets a value of 500, and so on.

  • EndpointDetails (dict) –

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

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: Vpc.

    • Vpc (dict) –

      The VPC configuration details for updating a web app endpoint hosted within a VPC. This includes the subnet IDs for endpoint deployment.

      • SubnetIds (list) –

        The list of subnet IDs within the VPC where the web app endpoint should be deployed during the update operation.

        • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'WebAppId': 'string'
}

Response Structure

  • (dict) –

    • WebAppId (string) –

      Returns the unique identifier for the web app being updated.

Exceptions