Appintegrations
This page documents function available when using the Appintegrations module, created with @service Appintegrations.
Index
Main.Appintegrations.create_applicationMain.Appintegrations.create_data_integrationMain.Appintegrations.create_event_integrationMain.Appintegrations.delete_applicationMain.Appintegrations.delete_data_integrationMain.Appintegrations.delete_event_integrationMain.Appintegrations.get_applicationMain.Appintegrations.get_data_integrationMain.Appintegrations.get_event_integrationMain.Appintegrations.list_application_associationsMain.Appintegrations.list_applicationsMain.Appintegrations.list_data_integration_associationsMain.Appintegrations.list_data_integrationsMain.Appintegrations.list_event_integration_associationsMain.Appintegrations.list_event_integrationsMain.Appintegrations.list_tags_for_resourceMain.Appintegrations.tag_resourceMain.Appintegrations.untag_resourceMain.Appintegrations.update_applicationMain.Appintegrations.update_data_integrationMain.Appintegrations.update_event_integration
Documentation
Main.Appintegrations.create_application — Methodcreate_application(application_source_config, name, namespace)
create_application(application_source_config, name, namespace, params::Dict{String,<:Any})This API is in preview release and subject to change. Creates and persists an Application resource.
Arguments
application_source_config: The configuration for where the application should be loaded from.name: The name of the application.namespace: The namespace of the application.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"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."Description": The description of the application."Permissions": The configuration of events or requests that the application has access to."Publications": The events that the application publishes."Subscriptions": The events that the application subscribes."Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Main.Appintegrations.create_data_integration — Methodcreate_data_integration(kms_key, name, source_uri)
create_data_integration(kms_key, name, source_uri, params::Dict{String,<:Any})Creates and persists a DataIntegration resource. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
Arguments
kms_key: The KMS key for the DataIntegration.name: The name of the DataIntegration.source_uri: The URI of the data source.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"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."Description": A description of the DataIntegration."FileConfiguration": The configuration for what files should be pulled from the source."ObjectConfiguration": The configuration for what data should be pulled from the source."ScheduleConfig": The name of the data and how often it should be pulled from the source."Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Main.Appintegrations.create_event_integration — Methodcreate_event_integration(event_bridge_bus, event_filter, name)
create_event_integration(event_bridge_bus, event_filter, name, params::Dict{String,<:Any})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. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane.
Arguments
event_bridge_bus: The EventBridge bus.event_filter: The event filter.name: The name of the event integration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"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."Description": The description of the event integration."Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Main.Appintegrations.delete_application — Methoddelete_application(application_identifier)
delete_application(application_identifier, params::Dict{String,<:Any})Deletes the Application. Only Applications that don't have any Application Associations can be deleted.
Arguments
application_identifier: The Amazon Resource Name (ARN) of the Application.
Main.Appintegrations.delete_data_integration — Methoddelete_data_integration(identifier)
delete_data_integration(identifier, params::Dict{String,<:Any})Deletes the DataIntegration. Only DataIntegrations that don't have any DataIntegrationAssociations can be deleted. Deleting a DataIntegration also deletes the underlying Amazon AppFlow flow and service linked role. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
Arguments
identifier: A unique identifier for the DataIntegration.
Main.Appintegrations.delete_event_integration — Methoddelete_event_integration(name)
delete_event_integration(name, params::Dict{String,<:Any})Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected.
Arguments
name: The name of the event integration.
Main.Appintegrations.get_application — Methodget_application(application_identifier)
get_application(application_identifier, params::Dict{String,<:Any})This API is in preview release and subject to change. Get an Application resource.
Arguments
application_identifier: The Amazon Resource Name (ARN) of the Application.
Main.Appintegrations.get_data_integration — Methodget_data_integration(identifier)
get_data_integration(identifier, params::Dict{String,<:Any})Returns information about the DataIntegration. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
Arguments
identifier: A unique identifier.
Main.Appintegrations.get_event_integration — Methodget_event_integration(name)
get_event_integration(name, params::Dict{String,<:Any})Returns information about the event integration.
Arguments
name: The name of the event integration.
Main.Appintegrations.list_application_associations — Methodlist_application_associations(application_identifier)
list_application_associations(application_identifier, params::Dict{String,<:Any})Returns a paginated list of application associations for an application.
Arguments
application_identifier: A unique identifier for the Application.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of results to return per page."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.
Main.Appintegrations.list_applications — Methodlist_applications()
list_applications(params::Dict{String,<:Any})This API is in preview release and subject to change. Lists applications in the account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of results to return per page."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.
Main.Appintegrations.list_data_integration_associations — Methodlist_data_integration_associations(identifier)
list_data_integration_associations(identifier, params::Dict{String,<:Any})Returns a paginated list of DataIntegration associations in the account. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
Arguments
identifier: A unique identifier for the DataIntegration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of results to return per page."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.
Main.Appintegrations.list_data_integrations — Methodlist_data_integrations()
list_data_integrations(params::Dict{String,<:Any})Returns a paginated list of DataIntegrations in the account. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of results to return per page."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.
Main.Appintegrations.list_event_integration_associations — Methodlist_event_integration_associations(name)
list_event_integration_associations(name, params::Dict{String,<:Any})Returns a paginated list of event integration associations in the account.
Arguments
name: The name of the event integration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of results to return per page."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.
Main.Appintegrations.list_event_integrations — Methodlist_event_integrations()
list_event_integrations(params::Dict{String,<:Any})Returns a paginated list of event integrations in the account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of results to return per page."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.
Main.Appintegrations.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Lists the tags for the specified resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.
Main.Appintegrations.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Adds the specified tags to the specified resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.tags: The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Main.Appintegrations.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes the specified tags from the specified resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.tag_keys: The tag keys.
Main.Appintegrations.update_application — Methodupdate_application(application_identifier)
update_application(application_identifier, params::Dict{String,<:Any})This API is in preview release and subject to change. Updates and persists an Application resource.
Arguments
application_identifier: The Amazon Resource Name (ARN) of the Application.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ApplicationSourceConfig": The configuration for where the application should be loaded from."Description": The description of the application."Name": The name of the application."Permissions": The configuration of events or requests that the application has access to."Publications": The events that the application publishes."Subscriptions": The events that the application subscribes.
Main.Appintegrations.update_data_integration — Methodupdate_data_integration(identifier)
update_data_integration(identifier, params::Dict{String,<:Any})Updates the description of a DataIntegration. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
Arguments
identifier: A unique identifier for the DataIntegration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Description": A description of the DataIntegration."Name": The name of the DataIntegration.
Main.Appintegrations.update_event_integration — Methodupdate_event_integration(name)
update_event_integration(name, params::Dict{String,<:Any})Updates the description of an event integration.
Arguments
name: The name of the event integration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Description": The description of the event integration.