Appintegrations

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

Index

Documentation

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.
  • "Description": The description of the event integration.
  • "Tags": One or more tags.
source
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.
source
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.
source
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.
source
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.
source
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: One or more tags.
source
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.
source
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.
source