AppIntegrationsServiceClient

Index > AppIntegrationsService > AppIntegrationsServiceClient

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

AppIntegrationsServiceClient

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

# AppIntegrationsServiceClient usage example

from boto3.session import Session
from types_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,
    client.exceptions.UnsupportedOperationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_appintegrations.client import Exceptions

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

Methods

can_paginate

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:
    ...

generate_presigned_url

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:
    ...

create_application

Creates and persists an Application resource.

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

# create_application method definition

def create_application(
    self,
    *,
    Name: str,
    Namespace: str,
    ApplicationSourceConfig: ApplicationSourceConfigUnionTypeDef,  # (1)
    Description: str = ...,
    Subscriptions: Sequence[SubscriptionTypeDef] = ...,  # (2)
    Publications: Sequence[PublicationTypeDef] = ...,  # (3)
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
    Permissions: Sequence[str] = ...,
    IsService: bool = ...,
    InitializationTimeout: int = ...,
    ApplicationConfig: ApplicationConfigTypeDef = ...,  # (4)
    IframeConfig: IframeConfigUnionTypeDef = ...,  # (5)
) -> CreateApplicationResponseTypeDef:  # (6)
    ...

1. See ApplicationSourceConfigUnionTypeDef
2. See Sequence[SubscriptionTypeDef]
3. See Sequence[PublicationTypeDef]
4. See ApplicationConfigTypeDef
5. See IframeConfigUnionTypeDef
6. See CreateApplicationResponseTypeDef

# create_application method usage example with argument unpacking

kwargs: CreateApplicationRequestTypeDef = {  # (1)
    "Name": ...,
    "Namespace": ...,
    "ApplicationSourceConfig": ...,
}

parent.create_application(**kwargs)

1. See CreateApplicationRequestTypeDef

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,
    Description: str = ...,
    SourceURI: str = ...,
    ScheduleConfig: ScheduleConfigurationTypeDef = ...,  # (1)
    Tags: Mapping[str, str] = ...,
    ClientToken: str = ...,
    FileConfiguration: FileConfigurationUnionTypeDef = ...,  # (2)
    ObjectConfiguration: Mapping[str, Mapping[str, Sequence[str]]] = ...,
) -> CreateDataIntegrationResponseTypeDef:  # (3)
    ...

1. See ScheduleConfigurationTypeDef
2. See FileConfigurationUnionTypeDef
3. See CreateDataIntegrationResponseTypeDef

# create_data_integration method usage example with argument unpacking

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

parent.create_data_integration(**kwargs)

1. See CreateDataIntegrationRequestTypeDef

create_data_integration_association

Creates and persists a DataIntegrationAssociation resource.

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

# create_data_integration_association method definition

def create_data_integration_association(
    self,
    *,
    DataIntegrationIdentifier: str,
    ClientId: str = ...,
    ObjectConfiguration: Mapping[str, Mapping[str, Sequence[str]]] = ...,
    DestinationURI: str = ...,
    ClientAssociationMetadata: Mapping[str, str] = ...,
    ClientToken: str = ...,
    ExecutionConfiguration: ExecutionConfigurationTypeDef = ...,  # (1)
) -> CreateDataIntegrationAssociationResponseTypeDef:  # (2)
    ...

1. See ExecutionConfigurationTypeDef
2. See CreateDataIntegrationAssociationResponseTypeDef

# create_data_integration_association method usage example with argument unpacking

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

parent.create_data_integration_association(**kwargs)

1. See CreateDataIntegrationAssociationRequestTypeDef

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: CreateEventIntegrationRequestTypeDef = {  # (1)
    "Name": ...,
    "EventFilter": ...,
    "EventBridgeBus": ...,
}

parent.create_event_integration(**kwargs)

1. See CreateEventIntegrationRequestTypeDef

delete_application

Deletes the Application.

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

# delete_application method definition

def delete_application(
    self,
    *,
    Arn: str,
) -> Dict[str, Any]:
    ...

# delete_application method usage example with argument unpacking

kwargs: DeleteApplicationRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.delete_application(**kwargs)

1. See DeleteApplicationRequestTypeDef

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: DeleteDataIntegrationRequestTypeDef = {  # (1)
    "DataIntegrationIdentifier": ...,
}

parent.delete_data_integration(**kwargs)

1. See DeleteDataIntegrationRequestTypeDef

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: DeleteEventIntegrationRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_event_integration(**kwargs)

1. See DeleteEventIntegrationRequestTypeDef

get_application

Get an Application resource.

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

# get_application method definition

def get_application(
    self,
    *,
    Arn: str,
) -> GetApplicationResponseTypeDef:  # (1)
    ...

1. See GetApplicationResponseTypeDef

# get_application method usage example with argument unpacking

kwargs: GetApplicationRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.get_application(**kwargs)

1. See GetApplicationRequestTypeDef

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: GetDataIntegrationRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.get_data_integration(**kwargs)

1. See GetDataIntegrationRequestTypeDef

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: GetEventIntegrationRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_event_integration(**kwargs)

1. See GetEventIntegrationRequestTypeDef

list_application_associations

Returns a paginated list of application associations for an application.

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

# list_application_associations method definition

def list_application_associations(
    self,
    *,
    ApplicationId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListApplicationAssociationsResponseTypeDef:  # (1)
    ...

1. See ListApplicationAssociationsResponseTypeDef

# list_application_associations method usage example with argument unpacking

kwargs: ListApplicationAssociationsRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.list_application_associations(**kwargs)

1. See ListApplicationAssociationsRequestTypeDef

list_applications

Lists applications in the account.

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

# list_applications method definition

def list_applications(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListApplicationsResponseTypeDef:  # (1)
    ...

1. See ListApplicationsResponseTypeDef

# list_applications method usage example with argument unpacking

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

parent.list_applications(**kwargs)

1. See ListApplicationsRequestTypeDef

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: ListDataIntegrationAssociationsRequestTypeDef = {  # (1)
    "DataIntegrationIdentifier": ...,
}

parent.list_data_integration_associations(**kwargs)

1. See ListDataIntegrationAssociationsRequestTypeDef

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: ListDataIntegrationsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_data_integrations(**kwargs)

1. See ListDataIntegrationsRequestTypeDef

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: ListEventIntegrationAssociationsRequestTypeDef = {  # (1)
    "EventIntegrationName": ...,
}

parent.list_event_integration_associations(**kwargs)

1. See ListEventIntegrationAssociationsRequestTypeDef

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: ListEventIntegrationsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_event_integrations(**kwargs)

1. See ListEventIntegrationsRequestTypeDef

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: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

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: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

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: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_application

Updates and persists an Application resource.

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

# update_application method definition

def update_application(
    self,
    *,
    Arn: str,
    Name: str = ...,
    Description: str = ...,
    ApplicationSourceConfig: ApplicationSourceConfigUnionTypeDef = ...,  # (1)
    Subscriptions: Sequence[SubscriptionTypeDef] = ...,  # (2)
    Publications: Sequence[PublicationTypeDef] = ...,  # (3)
    Permissions: Sequence[str] = ...,
    IsService: bool = ...,
    InitializationTimeout: int = ...,
    ApplicationConfig: ApplicationConfigTypeDef = ...,  # (4)
    IframeConfig: IframeConfigUnionTypeDef = ...,  # (5)
) -> Dict[str, Any]:
    ...

1. See ApplicationSourceConfigUnionTypeDef
2. See Sequence[SubscriptionTypeDef]
3. See Sequence[PublicationTypeDef]
4. See ApplicationConfigTypeDef
5. See IframeConfigUnionTypeDef

# update_application method usage example with argument unpacking

kwargs: UpdateApplicationRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.update_application(**kwargs)

1. See UpdateApplicationRequestTypeDef

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: UpdateDataIntegrationRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.update_data_integration(**kwargs)

1. See UpdateDataIntegrationRequestTypeDef

update_data_integration_association

Updates and persists a DataIntegrationAssociation resource.

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

# update_data_integration_association method definition

def update_data_integration_association(
    self,
    *,
    DataIntegrationIdentifier: str,
    DataIntegrationAssociationIdentifier: str,
    ExecutionConfiguration: ExecutionConfigurationTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See ExecutionConfigurationTypeDef

# update_data_integration_association method usage example with argument unpacking

kwargs: UpdateDataIntegrationAssociationRequestTypeDef = {  # (1)
    "DataIntegrationIdentifier": ...,
    "DataIntegrationAssociationIdentifier": ...,
    "ExecutionConfiguration": ...,
}

parent.update_data_integration_association(**kwargs)

1. See UpdateDataIntegrationAssociationRequestTypeDef

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: UpdateEventIntegrationRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.update_event_integration(**kwargs)

1. See UpdateEventIntegrationRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("appintegrations").get_paginator method with overloads.

• client.get_paginator("list_application_associations") -> ListApplicationAssociationsPaginator
• client.get_paginator("list_applications") -> ListApplicationsPaginator
• client.get_paginator("list_data_integration_associations") -> ListDataIntegrationAssociationsPaginator
• client.get_paginator("list_data_integrations") -> ListDataIntegrationsPaginator
• client.get_paginator("list_event_integration_associations") -> ListEventIntegrationAssociationsPaginator
• client.get_paginator("list_event_integrations") -> ListEventIntegrationsPaginator