AWS API Changes

2023/09/26 - Amazon AppIntegrations Service - 4 new api methods

Changes The Amazon AppIntegrations service adds a set of APIs (in preview) to manage third party applications to be used in Amazon Connect agent workspace.

GetApplication (new)

Link ¶

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'
    }
}

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

CreateApplication (new)

Link ¶

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

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

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.

UpdateApplication (new)

Link ¶

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

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.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

ListApplications (new)

Link ¶

This API is in preview release and subject to change.

Lists applications in the account.

See also: AWS API Documentation

Request Syntax

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

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

{
    'Applications': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Name': 'string',
            'Namespace': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Applications (list) --
  
  The Applications associated with this account.
  - (dict) --
    
    Summary information about the Application.
    - 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.
    - CreatedTime (datetime) --
      
      The time when the application was created.
    - LastModifiedTime (datetime) --
      
      The time when the application was last modified.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.