AppIntegrationsService / Client / update_application

update_application¶

AppIntegrationsService.Client.update_application(**kwargs)¶

Updates and persists an Application resource.

Request Syntax

response = client.update_application(
    Arn='string',
    Name='string',
    Description='string',
    ApplicationSourceConfig={
        'ExternalUrlConfig': {
            'AccessUrl': 'string',
            'ApprovedOrigins': [
                'string',
            ]
        }
    },
    Subscriptions=[
        {
            'Event': 'string',
            'Description': 'string'
        },
    ],
    Publications=[
        {
            'Event': 'string',
            'Schema': 'string',
            'Description': 'string'
        },
    ],
    Permissions=[
        'string',
    ],
    IsService=True|False,
    InitializationTimeout=123,
    ApplicationConfig={
        'ContactHandling': {
            'Scope': 'CROSS_CONTACTS'|'PER_CONTACT'
        }
    },
    IframeConfig={
        'Allow': [
            'string',
        ],
        'Sandbox': [
            'string',
        ]
    }
)

Parameters:

Arn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the Application.
Name (string) – The name of the application.
Description (string) – The description of the application.
ApplicationSourceConfig (dict) –
The configuration for where the application should be loaded from.
- ExternalUrlConfig (dict) –
  
  The external URL source for the application.
  - AccessUrl (string) – [REQUIRED]
    
    The URL to access the application.
  - ApprovedOrigins (list) –
    
    Additional URLs to allow list if different than the access URL.
    - (string) –
Subscriptions (list) –
The events that the application subscribes.
- (dict) –
  
  The configuration of an event that the application subscribes.
  - Event (string) – [REQUIRED]
    
    The name of the subscription.
  - Description (string) –
    
    The description of the subscription.
Publications (list) –
The events that the application publishes.
- (dict) –
  
  The configuration of an event that the application publishes.
  - Event (string) – [REQUIRED]
    
    The name of the publication.
  - Schema (string) – [REQUIRED]
    
    The JSON schema of the publication event.
  - Description (string) –
    
    The description of the publication.
Permissions (list) –
The configuration of events or requests that the application has access to.
- (string) –
  
  The permission of an event or request that the application has access to.
IsService (boolean) – Indicates whether the application is a service.
InitializationTimeout (integer) – The maximum time in milliseconds allowed to establish a connection with the workspace.
ApplicationConfig (dict) –
The configuration settings for the application.
- ContactHandling (dict) –
  
  The contact handling configuration for the application.
  - Scope (string) –
    
    Indicates whether the application refreshes for each contact or refreshes only with each new browser session.
IframeConfig (dict) –
The iframe configuration for the application.
- Allow (list) –
  
  The list of features that are allowed in the iframe.
  - (string) –
    
    A permission for the iframe.
- Sandbox (list) –
  
  The list of sandbox attributes for the iframe.
  - (string) –
    
    A permission for the iframe.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

AppIntegrationsService.Client.exceptions.InternalServiceError
AppIntegrationsService.Client.exceptions.ThrottlingException
AppIntegrationsService.Client.exceptions.ResourceNotFoundException
AppIntegrationsService.Client.exceptions.InvalidRequestException
AppIntegrationsService.Client.exceptions.AccessDeniedException
AppIntegrationsService.Client.exceptions.UnsupportedOperationException