AWS API Changes

2024/12/02 - AWS Transfer Family - 8 new api methods

Changes AWS Transfer Family now offers Web apps that enables simple and secure access to data stored in Amazon S3.

DeleteWebAppCustomization (new)

Link ¶

Deletes the WebAppCustomization object that corresponds to the web app ID specified.

Request Syntax

client.delete_web_app_customization(
    WebAppId='string'
)

type WebAppId:

string

param WebAppId:

[REQUIRED]

Provide the unique identifier for the web app that contains the customizations that you are deleting.

returns:

None

DescribeWebApp (new)

Link ¶

Describes the web app that's identified by WebAppId.

See also: AWS API Documentation

Request Syntax

client.describe_web_app(
    WebAppId='string'
)

type WebAppId:

string

param WebAppId:

[REQUIRED]

Provide the unique identifier for the web app.

rtype:

dict

returns:

Response Syntax

{
    'WebApp': {
        'Arn': 'string',
        'WebAppId': 'string',
        'DescribedIdentityProviderDetails': {
            'IdentityCenterConfig': {
                'ApplicationArn': 'string',
                'InstanceArn': 'string',
                'Role': 'string'
            }
        },
        'AccessEndpoint': 'string',
        'WebAppEndpoint': 'string',
        'WebAppUnits': {
            'Provisioned': 123
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- WebApp (dict) --
  
  Returns a structure that contains the details of the web app.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the web app.
  - WebAppId (string) --
    
    The unique identifier for the web app.
  - DescribedIdentityProviderDetails (dict) --
    
    A structure that contains the details for the identity provider used by the web app.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: IdentityCenterConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - IdentityCenterConfig (dict) --
      
      Returns a structure for your identity provider details. This structure contains the instance ARN and role being used for the web app.
      - ApplicationArn (string) --
        
        The Amazon Resource Name (ARN) for the IAM Identity Center application: this value is set automatically when you create your 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.
  - WebAppEndpoint (string) --
    
    The WebAppEndpoint is the unique URL for your Transfer Family web app. This is the value that you use when you configure Origins on CloudFront.
  - 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 will be set: Provisioned. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - 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. Tags are metadata attached to web apps for any purpose.
    - (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) --
        
        The name assigned to the tag that you create.
      - Value (string) --
        
        Contains one or more values that you assigned to the key name you create.

ListWebApps (new)

Link ¶

Lists all web apps associated with your Amazon Web Services account for your current region.

See also: AWS API Documentation

Request Syntax

client.list_web_apps(
    MaxResults=123,
    NextToken='string'
)

type MaxResults:

integer

param MaxResults:

The maximum number of items to return.

type NextToken:

string

param NextToken:

Returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional web apps.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'WebApps': [
        {
            'Arn': 'string',
            'WebAppId': 'string',
            'AccessEndpoint': 'string',
            'WebAppEndpoint': 'string'
        },
    ]
}

Response Structure

(dict) --
- NextToken (string) --
  
  Provide this value for the NextToken parameter in a subsequent command to continue listing additional web apps.
- WebApps (list) --
  
  Returns, for each listed web app, a structure that contains details for the web app.
  - (dict) --
    
    a structure that contains details for the web app.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) for the web app.
    - WebAppId (string) --
      
      The unique identifier 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.
    - WebAppEndpoint (string) --
      
      The WebAppEndpoint is the unique URL for your Transfer Family web app. This is the value that you use when you configure Origins on CloudFront.

CreateWebApp (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

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

type IdentityProviderDetails:

dict

param IdentityProviderDetails:

[REQUIRED]

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

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.

type AccessEndpoint:

string

param 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 WebAppUnits:

dict

param WebAppUnits:

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

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.

type Tags:

list

param Tags:

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.

rtype:

dict

returns:

Response Syntax

{
    'WebAppId': 'string'
}

Response Structure

(dict) --
- WebAppId (string) --
  
  Returns a unique identifier for the web app.

DeleteWebApp (new)

Link ¶

Deletes the specified web app.

See also: AWS API Documentation

Request Syntax

client.delete_web_app(
    WebAppId='string'
)

type WebAppId:

string

param WebAppId:

[REQUIRED]

Provide the unique identifier for the web app that you are deleting.

returns:

None

UpdateWebAppCustomization (new)

Link ¶

Assigns new customization properties to a web app. You can modify the icon file, logo file, and title.

See also: AWS API Documentation

Request Syntax

client.update_web_app_customization(
    WebAppId='string',
    Title='string',
    LogoFile=b'bytes',
    FaviconFile=b'bytes'
)

type WebAppId:

string

param WebAppId:

[REQUIRED]

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

type Title:

string

param Title:

Provide an updated title.

type LogoFile:

bytes

param LogoFile:

Specify logo file data string (in base64 encoding).

type FaviconFile:

bytes

param FaviconFile:

Specify icon file data string (in base64 encoding).

rtype:

dict

returns:

Response Syntax

{
    'WebAppId': 'string'
}

Response Structure

(dict) --
- WebAppId (string) --
  
  Returns the unique identifier for the web app being updated.

UpdateWebApp (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.update_web_app(
    WebAppId='string',
    IdentityProviderDetails={
        'IdentityCenterConfig': {
            'Role': 'string'
        }
    },
    AccessEndpoint='string',
    WebAppUnits={
        'Provisioned': 123
    }
)

type WebAppId:

string

param WebAppId:

[REQUIRED]

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

type IdentityProviderDetails:

dict

param IdentityProviderDetails:

Provide updated identity provider values in a WebAppIdentityProviderDetails object.

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.

type AccessEndpoint:

string

param 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 WebAppUnits:

dict

param WebAppUnits:

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

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.

rtype:

dict

returns:

Response Syntax

{
    'WebAppId': 'string'
}

Response Structure

(dict) --
- WebAppId (string) --
  
  Returns the unique identifier for the web app being updated.

DescribeWebAppCustomization (new)

Link ¶

Describes the web app customization object that's identified by WebAppId.

See also: AWS API Documentation

Request Syntax

client.describe_web_app_customization(
    WebAppId='string'
)

type WebAppId:

string

param WebAppId:

[REQUIRED]

Provide the unique identifier for the web app.

rtype:

dict

returns:

Response Syntax

{
    'WebAppCustomization': {
        'Arn': 'string',
        'WebAppId': 'string',
        'Title': 'string',
        'LogoFile': b'bytes',
        'FaviconFile': b'bytes'
    }
}

Response Structure

(dict) --
- WebAppCustomization (dict) --
  
  Returns a structure that contains the details of the web app customizations.
  - Arn (string) --
    
    Returns the Amazon Resource Name (ARN) for the web app.
  - WebAppId (string) --
    
    Returns the unique identifier for your web app.
  - Title (string) --
    
    Returns the page title that you defined for your web app.
  - LogoFile (bytes) --
    
    Returns a logo file data string (in base64 encoding).
  - FaviconFile (bytes) --
    
    Returns a icon file data string (in base64 encoding).