Skip to content

AppIntegrationsServiceClient#

Index > AppIntegrationsService > AppIntegrationsServiceClient

Auto-generated documentation for AppIntegrationsService type annotations stubs module mypy-boto3-appintegrations.

AppIntegrationsServiceClient#

Type annotations and code completion for boto3.client("appintegrations"). boto3 documentation

# AppIntegrationsServiceClient usage example

from boto3.session import Session
from mypy_boto3_appintegrations.client import AppIntegrationsServiceClient

def get_appintegrations_client() -> AppIntegrationsServiceClient:
    return Session().client("appintegrations")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("appintegrations").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("appintegrations")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.DuplicateResourceException,
    client.exceptions.InternalServiceError,
    client.exceptions.InvalidRequestException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourceQuotaExceededException,
    client.exceptions.ThrottlingException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_appintegrations.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("appintegrations").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("appintegrations").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_data_integration#

Creates and persists a DataIntegration resource.

Type annotations and code completion for boto3.client("appintegrations").create_data_integration method. boto3 documentation

# create_data_integration method definition

def create_data_integration(
    self,
    *,
    Name: str,
    KmsKey: str,
    SourceURI: str,
    ScheduleConfig: ScheduleConfigurationTypeDef,  # (1)
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
    ClientToken: str = ...,
    FileConfiguration: FileConfigurationTypeDef = ...,  # (2)
    ObjectConfiguration: Mapping[str, Mapping[str, Sequence[str]]] = ...,
) -> CreateDataIntegrationResponseTypeDef:  # (3)
    ...
  1. See ScheduleConfigurationTypeDef
  2. See FileConfigurationTypeDef
  3. See CreateDataIntegrationResponseTypeDef 
# create_data_integration method usage example with argument unpacking

kwargs: CreateDataIntegrationRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "KmsKey": ...,
    "SourceURI": ...,
    "ScheduleConfig": ...,
}

parent.create_data_integration(**kwargs)
  1. See CreateDataIntegrationRequestRequestTypeDef

create_event_integration#

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 pushes events to that bus.

Type annotations and code completion for boto3.client("appintegrations").create_event_integration method. boto3 documentation

# create_event_integration method definition

def create_event_integration(
    self,
    *,
    Name: str,
    EventFilter: EventFilterTypeDef,  # (1)
    EventBridgeBus: str,
    Description: str = ...,
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateEventIntegrationResponseTypeDef:  # (2)
    ...
  1. See EventFilterTypeDef
  2. See CreateEventIntegrationResponseTypeDef 
# create_event_integration method usage example with argument unpacking

kwargs: CreateEventIntegrationRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "EventFilter": ...,
    "EventBridgeBus": ...,
}

parent.create_event_integration(**kwargs)
  1. See CreateEventIntegrationRequestRequestTypeDef

delete_data_integration#

Deletes the DataIntegration.

Type annotations and code completion for boto3.client("appintegrations").delete_data_integration method. boto3 documentation

# delete_data_integration method definition

def delete_data_integration(
    self,
    *,
    DataIntegrationIdentifier: str,
) -> Dict[str, Any]:
    ...
# delete_data_integration method usage example with argument unpacking

kwargs: DeleteDataIntegrationRequestRequestTypeDef = {  # (1)
    "DataIntegrationIdentifier": ...,
}

parent.delete_data_integration(**kwargs)
  1. See DeleteDataIntegrationRequestRequestTypeDef

delete_event_integration#

Deletes the specified existing event integration.

Type annotations and code completion for boto3.client("appintegrations").delete_event_integration method. boto3 documentation

# delete_event_integration method definition

def delete_event_integration(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
# delete_event_integration method usage example with argument unpacking

kwargs: DeleteEventIntegrationRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_event_integration(**kwargs)
  1. See DeleteEventIntegrationRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("appintegrations").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_data_integration#

Returns information about the DataIntegration.

Type annotations and code completion for boto3.client("appintegrations").get_data_integration method. boto3 documentation

# get_data_integration method definition

def get_data_integration(
    self,
    *,
    Identifier: str,
) -> GetDataIntegrationResponseTypeDef:  # (1)
    ...
  1. See GetDataIntegrationResponseTypeDef 
# get_data_integration method usage example with argument unpacking

kwargs: GetDataIntegrationRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.get_data_integration(**kwargs)
  1. See GetDataIntegrationRequestRequestTypeDef

get_event_integration#

Returns information about the event integration.

Type annotations and code completion for boto3.client("appintegrations").get_event_integration method. boto3 documentation

# get_event_integration method definition

def get_event_integration(
    self,
    *,
    Name: str,
) -> GetEventIntegrationResponseTypeDef:  # (1)
    ...
  1. See GetEventIntegrationResponseTypeDef 
# get_event_integration method usage example with argument unpacking

kwargs: GetEventIntegrationRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_event_integration(**kwargs)
  1. See GetEventIntegrationRequestRequestTypeDef

list_data_integration_associations#

Returns a paginated list of DataIntegration associations in the account.

Type annotations and code completion for boto3.client("appintegrations").list_data_integration_associations method. boto3 documentation

# list_data_integration_associations method definition

def list_data_integration_associations(
    self,
    *,
    DataIntegrationIdentifier: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDataIntegrationAssociationsResponseTypeDef:  # (1)
    ...
  1. See ListDataIntegrationAssociationsResponseTypeDef 
# list_data_integration_associations method usage example with argument unpacking

kwargs: ListDataIntegrationAssociationsRequestRequestTypeDef = {  # (1)
    "DataIntegrationIdentifier": ...,
}

parent.list_data_integration_associations(**kwargs)
  1. See ListDataIntegrationAssociationsRequestRequestTypeDef

list_data_integrations#

Returns a paginated list of DataIntegrations in the account.

Type annotations and code completion for boto3.client("appintegrations").list_data_integrations method. boto3 documentation

# list_data_integrations method definition

def list_data_integrations(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDataIntegrationsResponseTypeDef:  # (1)
    ...
  1. See ListDataIntegrationsResponseTypeDef 
# list_data_integrations method usage example with argument unpacking

kwargs: ListDataIntegrationsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_data_integrations(**kwargs)
  1. See ListDataIntegrationsRequestRequestTypeDef

list_event_integration_associations#

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

Type annotations and code completion for boto3.client("appintegrations").list_event_integration_associations method. boto3 documentation

# list_event_integration_associations method definition

def list_event_integration_associations(
    self,
    *,
    EventIntegrationName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEventIntegrationAssociationsResponseTypeDef:  # (1)
    ...
  1. See ListEventIntegrationAssociationsResponseTypeDef 
# list_event_integration_associations method usage example with argument unpacking

kwargs: ListEventIntegrationAssociationsRequestRequestTypeDef = {  # (1)
    "EventIntegrationName": ...,
}

parent.list_event_integration_associations(**kwargs)
  1. See ListEventIntegrationAssociationsRequestRequestTypeDef

list_event_integrations#

Returns a paginated list of event integrations in the account.

Type annotations and code completion for boto3.client("appintegrations").list_event_integrations method. boto3 documentation

# list_event_integrations method definition

def list_event_integrations(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEventIntegrationsResponseTypeDef:  # (1)
    ...
  1. See ListEventIntegrationsResponseTypeDef 
# list_event_integrations method usage example with argument unpacking

kwargs: ListEventIntegrationsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_event_integrations(**kwargs)
  1. See ListEventIntegrationsRequestRequestTypeDef

list_tags_for_resource#

Lists the tags for the specified resource.

Type annotations and code completion for boto3.client("appintegrations").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

tag_resource#

Adds the specified tags to the specified resource.

Type annotations and code completion for boto3.client("appintegrations").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Removes the specified tags from the specified resource.

Type annotations and code completion for boto3.client("appintegrations").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_data_integration#

Updates the description of a DataIntegration.

Type annotations and code completion for boto3.client("appintegrations").update_data_integration method. boto3 documentation

# update_data_integration method definition

def update_data_integration(
    self,
    *,
    Identifier: str,
    Name: str = ...,
    Description: str = ...,
) -> Dict[str, Any]:
    ...
# update_data_integration method usage example with argument unpacking

kwargs: UpdateDataIntegrationRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.update_data_integration(**kwargs)
  1. See UpdateDataIntegrationRequestRequestTypeDef

update_event_integration#

Updates the description of an event integration.

Type annotations and code completion for boto3.client("appintegrations").update_event_integration method. boto3 documentation

# update_event_integration method definition

def update_event_integration(
    self,
    *,
    Name: str,
    Description: str = ...,
) -> Dict[str, Any]:
    ...
# update_event_integration method usage example with argument unpacking

kwargs: UpdateEventIntegrationRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.update_event_integration(**kwargs)
  1. See UpdateEventIntegrationRequestRequestTypeDef