Transfer / Client / create_web_app

create_web_app

Transfer.Client.create_web_app(**kwargs)

Creates a web app based on specified parameters, and returns the ID for the new web app.

See also: AWS API Documentation

Request Syntax

response = client.create_web_app(
    IdentityProviderDetails={
        'IdentityCenterConfig': {
            'InstanceArn': 'string',
            'Role': 'string'
        }
    },
    AccessEndpoint='string',
    WebAppUnits={
        'Provisioned': 123
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• IdentityProviderDetails (dict) –

  [REQUIRED]

  You can provide a structure that contains the details for the identity provider to use with your web app.

  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 create a web app.

    • InstanceArn (string) –

      The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app.

    • Role (string) –

      The IAM role in IAM Identity Center used for the web app.

• 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.

• Tags (list) –

  Key-value pairs that can be used to group and search for web apps.

  • (dict) –

    Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

    • Key (string) – [REQUIRED]

      The name assigned to the tag that you create.

    • Value (string) – [REQUIRED]

      Contains one or more values that you assigned to the key name you create.

Return type:

dict

Returns:

Response Syntax

{
    'WebAppId': 'string'
}

Response Structure

• (dict) –

  • WebAppId (string) –

    Returns a unique identifier for the web app.

Exceptions

• Transfer.Client.exceptions.ResourceNotFoundException

• Transfer.Client.exceptions.InvalidRequestException

• Transfer.Client.exceptions.ThrottlingException

• Transfer.Client.exceptions.InternalServiceError

• Transfer.Client.exceptions.AccessDeniedException