AWS API Changes

2023/12/21 - Amazon AppIntegrations Service - 2 new3 updated api methods

Changes The Amazon AppIntegrations service adds DeleteApplication API for deleting applications, and updates APIs to support third party applications reacting to workspace events and make data requests to Amazon Connect for agent and contact events.

ListApplicationAssociations (new)

Link ¶

Returns a paginated list of application associations for an application.

See also: AWS API Documentation

Request Syntax

client.list_application_associations(
    ApplicationId='string',
    NextToken='string',
    MaxResults=123
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED]

A unique identifier for the Application.

type NextToken:

string

param NextToken:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return per page.

rtype:

dict

returns:

Response Syntax

{
    'ApplicationAssociations': [
        {
            'ApplicationAssociationArn': 'string',
            'ApplicationArn': 'string',
            'ClientId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ApplicationAssociations (list) --
  
  List of Application Associations for the Application.
  - (dict) --
    
    Summary information about the Application Association.
    - ApplicationAssociationArn (string) --
      
      The Amazon Resource Name (ARN) of the Application Association.
    - ApplicationArn (string) --
      
      The Amazon Resource Name (ARN) of the Application.
    - ClientId (string) --
      
      The identifier for the client that is associated with the Application Association.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

DeleteApplication (new)

Link ¶

Deletes the Application. Only Applications that don't have any Application Associations can be deleted.

See also: AWS API Documentation

Request Syntax

client.delete_application(
    Arn='string'
)

type Arn:

string

param Arn:

[REQUIRED]

The Amazon Resource Name (ARN) of the Application.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

CreateApplication (updated)

Link ¶
Changes (request)

{'Permissions': ['string']}

This API is in preview release and subject to change.

Creates and persists an Application resource.

See also: AWS API Documentation

Request Syntax

client.create_application(
    Name='string',
    Namespace='string',
    Description='string',
    ApplicationSourceConfig={
        'ExternalUrlConfig': {
            'AccessUrl': 'string',
            'ApprovedOrigins': [
                'string',
            ]
        }
    },
    Subscriptions=[
        {
            'Event': 'string',
            'Description': 'string'
        },
    ],
    Publications=[
        {
            'Event': 'string',
            'Schema': 'string',
            'Description': 'string'
        },
    ],
    ClientToken='string',
    Tags={
        'string': 'string'
    },
    Permissions=[
        'string',
    ]
)

type Name:

string

param Name:

[REQUIRED]

The name of the application.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace of the application.

type Description:

string

param Description:

The description of the application.

type ApplicationSourceConfig:

dict

param ApplicationSourceConfig:

[REQUIRED]

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) --

type Subscriptions:

list

param Subscriptions:

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.

type Publications:

list

param Publications:

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.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

type Tags:

dict

param Tags:

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

(string) --
- (string) --

type Permissions:

list

param Permissions:

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.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Id': 'string'
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the Application.
- Id (string) --
  
  A unique identifier for the Application.

GetApplication (updated)

Link ¶
Changes (response)

{'Permissions': ['string']}

This API is in preview release and subject to change.

Get an Application resource.

See also: AWS API Documentation

Request Syntax

client.get_application(
    Arn='string'
)

type Arn:

string

param Arn:

[REQUIRED]

The Amazon Resource Name (ARN) of the Application.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Id': 'string',
    'Name': 'string',
    'Namespace': 'string',
    'Description': 'string',
    'ApplicationSourceConfig': {
        'ExternalUrlConfig': {
            'AccessUrl': 'string',
            'ApprovedOrigins': [
                'string',
            ]
        }
    },
    'Subscriptions': [
        {
            'Event': 'string',
            'Description': 'string'
        },
    ],
    'Publications': [
        {
            'Event': 'string',
            'Schema': 'string',
            'Description': 'string'
        },
    ],
    'CreatedTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'Tags': {
        'string': 'string'
    },
    'Permissions': [
        'string',
    ]
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the Application.
- Id (string) --
  
  A unique identifier for the Application.
- Name (string) --
  
  The name of the application.
- Namespace (string) --
  
  The namespace 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) --
      
      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) --
      
      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) --
      
      The name of the publication.
    - Schema (string) --
      
      The JSON schema of the publication event.
    - Description (string) --
      
      The description of the publication.
- CreatedTime (datetime) --
  
  The created time of the Application.
- LastModifiedTime (datetime) --
  
  The last modified time of the Application.
- Tags (dict) --
  
  The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
  - (string) --
    - (string) --
- 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.

UpdateApplication (updated)

Link ¶
Changes (request)

{'Permissions': ['string']}

This API is in preview release and subject to change.

Updates and persists an Application resource.

See also: AWS API Documentation

Request Syntax

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',
    ]
)

type Arn:

string

param Arn:

[REQUIRED]

The Amazon Resource Name (ARN) of the Application.

type Name:

string

param Name:

The name of the application.

type Description:

string

param Description:

The description of the application.

type ApplicationSourceConfig:

dict

param ApplicationSourceConfig:

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) --

type Subscriptions:

list

param Subscriptions:

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.

type Publications:

list

param Publications:

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.

type Permissions:

list

param Permissions:

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.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --