Appintegrations

This page documents function available when using the Appintegrations module, created with @service Appintegrations.

Index

Documentation

Main.Appintegrations.create_data_integrationMethod
create_data_integration(kms_key, name, schedule_config, source_uri)
create_data_integration(kms_key, name, schedule_config, 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.
  • schedule_config: The name of the data and how often it should be pulled from the source.
  • 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.
  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Main.Appintegrations.create_event_integrationMethod
create_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_data_integrationMethod
delete_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_integrationMethod
delete_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_data_integrationMethod
get_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_integrationMethod
get_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_data_integration_associationsMethod
list_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_integrationsMethod
list_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_associationsMethod
list_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_integrationsMethod
list_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_resourceMethod
list_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_resourceMethod
tag_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_resourceMethod
untag_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_data_integrationMethod
update_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_integrationMethod
update_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 inegration.