AWS API Changes

2020/12/01 - Amazon AppIntegrations Service - 9 new api methods

Changes The Amazon AppIntegrations service (in preview release) enables you to configure and reuse connections to external applications.

DeleteEventIntegration (new)

Link ¶

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected.

See also: AWS API Documentation

Request Syntax

client.delete_event_integration(
    Name='string'
)

type Name

string

param Name

[REQUIRED]

The name of the event integration.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

UntagResource (new)

Link ¶

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Removes the specified tags from the specified resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)

type resourceArn

string

param resourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

type tagKeys

list

param tagKeys

[REQUIRED]

The tag keys.

(string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

UpdateEventIntegration (new)

Link ¶

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Updates the description of an event integration.

See also: AWS API Documentation

Request Syntax

client.update_event_integration(
    Name='string',
    Description='string'
)

type Name

string

param Name

[REQUIRED]

The name of the event integration.

type Description

string

param Description

The description of the event inegration.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

CreateEventIntegration (new)

Link ¶

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Creates an EventIntegration, given a specified name, description, and a reference to an Amazon Eventbridge bus in your account and a partner event source that will push events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane.

See also: AWS API Documentation

Request Syntax

client.create_event_integration(
    Name='string',
    Description='string',
    EventFilter={
        'Source': 'string'
    },
    EventBridgeBus='string',
    ClientToken='string',
    Tags={
        'string': 'string'
    }
)

type Name

string

param Name

[REQUIRED]

The name of the event integration.

type Description

string

param Description

The description of the event integration.

type EventFilter

dict

param EventFilter

[REQUIRED]

The event filter.

Source (string) -- [REQUIRED]

The source of the events.

type EventBridgeBus

string

param EventBridgeBus

[REQUIRED]

The Eventbridge bus.

type ClientToken

string

param ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

type Tags

dict

param Tags

One or more tags.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'EventIntegrationArn': 'string'
}

Response Structure

(dict) --
- EventIntegrationArn (string) --
  
  The Amazon Resource Name (ARN) of the event integration.

ListTagsForResource (new)

Link ¶

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Lists the tags for the specified resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)

type resourceArn

string

param resourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

rtype

dict

returns

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- tags (dict) --
  
  Information about the tags.
  - (string) --
    - (string) --

ListEventIntegrations (new)

Link ¶

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Returns a paginated list of event integrations in the account.

See also: AWS API Documentation

Request Syntax

client.list_event_integrations(
    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

{
    'EventIntegrations': [
        {
            'EventIntegrationArn': 'string',
            'Name': 'string',
            'Description': 'string',
            'EventFilter': {
                'Source': 'string'
            },
            'EventBridgeBus': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- EventIntegrations (list) --
  
  The event integrations.
  - (dict) --
    
    The Amazon AppIntegrations APIs are in preview release and are subject to change.
    
    The event integration.
    - EventIntegrationArn (string) --
      
      The Amazon Resource Name (ARN) of the event integration.
    - Name (string) --
      
      The name of the event integration.
    - Description (string) --
      
      The event integration description.
    - EventFilter (dict) --
      
      The event integration filter.
      - Source (string) --
        
        The source of the events.
    - EventBridgeBus (string) --
      
      The Amazon Eventbridge bus for the event integration.
    - Tags (dict) --
      
      The tags.
      - (string) --
        
        (string) --
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

TagResource (new)

Link ¶

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Adds the specified tags to the specified resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)

type resourceArn

string

param resourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

type tags

dict

param tags

[REQUIRED]

One or more tags.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

GetEventIntegration (new)

Link ¶

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Return information about the event integration.

See also: AWS API Documentation

Request Syntax

client.get_event_integration(
    Name='string'
)

type Name

string

param Name

[REQUIRED]

The name of the event integration.

rtype

dict

returns

Response Syntax

{
    'Name': 'string',
    'Description': 'string',
    'EventIntegrationArn': 'string',
    'EventBridgeBus': 'string',
    'EventFilter': {
        'Source': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- Name (string) --
  
  The name of the event integration.
- Description (string) --
  
  The description of the event integration.
- EventIntegrationArn (string) --
  
  The Amazon Resource Name (ARN) for the event integration.
- EventBridgeBus (string) --
  
  The Eventbridge bus.
- EventFilter (dict) --
  
  The event filter.
  - Source (string) --
    
    The source of the events.
- Tags (dict) --
  
  One or more tags.
  - (string) --
    - (string) --

ListEventIntegrationAssociations (new)

Link ¶

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Returns a paginated list of event integration associations in the account.

See also: AWS API Documentation

Request Syntax

client.list_event_integration_associations(
    EventIntegrationName='string',
    NextToken='string',
    MaxResults=123
)

type EventIntegrationName

string

param EventIntegrationName

[REQUIRED]

The name of the event integration.

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

{
    'EventIntegrationAssociations': [
        {
            'EventIntegrationAssociationArn': 'string',
            'EventIntegrationAssociationId': 'string',
            'EventIntegrationName': 'string',
            'ClientId': 'string',
            'EventBridgeRuleName': 'string',
            'ClientAssociationMetadata': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- EventIntegrationAssociations (list) --
  
  The event integration associations.
  - (dict) --
    
    The Amazon AppIntegrations APIs are in preview release and are subject to change.
    
    The event integration association.
    - EventIntegrationAssociationArn (string) --
      
      The Amazon Resource Name (ARN) for the event integration association.
    - EventIntegrationAssociationId (string) --
      
      The identifier for the event integration association.
    - EventIntegrationName (string) --
      
      The name of the event integration.
    - ClientId (string) --
      
      The identifier for the client that is associated with the event integration.
    - EventBridgeRuleName (string) --
      
      The name of the Eventbridge rule.
    - ClientAssociationMetadata (dict) --
      
      The metadata associated with the client.
      - (string) --
        
        (string) --
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.