Class: Aws::AppIntegrationsService::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-appintegrationsservice/client.rb

Overview

An API client for AppIntegrationsService. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::AppIntegrationsService::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::AppIntegrationsService::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::AppIntegrationsService::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 473

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1876
1877
1878
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1876

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1879
1880
1881
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1879

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1849

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::AppIntegrationsService')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-appintegrationsservice'
  context[:gem_version] = '1.61.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_application(params = {}) ⇒ Types::CreateApplicationResponse

Creates and persists an Application resource.

Examples:

Example: To create an application


# The following creates an application named My Application with access url https://example.com.

resp = client.create_application({
  application_source_config: {
    external_url_config: {
      access_url: "https://example.com", 
    }, 
  }, 
  description: "My first application.", 
  name: "My Application", 
  namespace: "myapplication", 
})

resp.to_h outputs the following:
{
  arn: "arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e", 
  id: "98542c53-e8ac-4570-9c85-c6552c8d9c5e", 
}

Request syntax with placeholder values


resp = client.create_application({
  name: "ApplicationName", # required
  namespace: "ApplicationNamespace", # required
  description: "Description",
  application_source_config: { # required
    external_url_config: {
      access_url: "URL", # required
      approved_origins: ["ApplicationTrustedSource"],
    },
  },
  subscriptions: [
    {
      event: "EventName", # required
      description: "Description",
    },
  ],
  publications: [
    {
      event: "EventName", # required
      schema: "EventDefinitionSchema", # required
      description: "Description",
    },
  ],
  client_token: "IdempotencyToken",
  tags: {
    "TagKey" => "TagValue",
  },
  permissions: ["Permission"],
  is_service: false,
  initialization_timeout: 1,
  application_config: {
    contact_handling: {
      scope: "CROSS_CONTACTS", # accepts CROSS_CONTACTS, PER_CONTACT
    },
  },
  iframe_config: {
    allow: ["IframePermission"],
    sandbox: ["IframePermission"],
  },
  application_type: "STANDARD", # accepts STANDARD, SERVICE, MCP_SERVER
})

Response structure


resp.arn #=> String
resp.id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the application.

  • :namespace (required, String) —

    The namespace of the application.

  • :description (String) —

    The description of the application.

  • :application_source_config (required, Types::ApplicationSourceConfig) —

    The configuration for where the application should be loaded from.

  • :subscriptions (Array<Types::Subscription>) —

    The events that the application subscribes.

  • :publications (Array<Types::Publication>) —

    The events that the application publishes.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { “tags”: “key2”:“value2” }.

  • :permissions (Array<String>) —

    The configuration of events or requests that the application has access to.

  • :is_service (Boolean) —

    Indicates whether the application is a service.

  • :initialization_timeout (Integer) —

    The maximum time in milliseconds allowed to establish a connection with the workspace.

  • :application_config (Types::ApplicationConfig) —

    The configuration settings for the application.

  • :iframe_config (Types::IframeConfig) —

    The iframe configuration for the application.

  • :application_type (String) —

    The type of application.

Returns:

See Also:



617
618
619
620
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 617

def create_application(params = {}, options = {})
  req = build_request(:create_application, params)
  req.send_request(options)
end

#create_data_integration(params = {}) ⇒ Types::CreateDataIntegrationResponse

Creates and persists a DataIntegration resource.

<note markdown=“1”> 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.

</note>

Examples:

Request syntax with placeholder values


resp = client.create_data_integration({
  name: "Name", # required
  description: "Description",
  kms_key: "NonBlankString", # required
  source_uri: "SourceURI",
  schedule_config: {
    first_execution_from: "NonBlankString",
    object: "Object",
    schedule_expression: "NonBlankString", # required
  },
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "IdempotencyToken",
  file_configuration: {
    folders: ["NonBlankLongString"], # required
    filters: {
      "NonBlankString" => ["Fields"],
    },
  },
  object_configuration: {
    "NonBlankString" => {
      "NonBlankString" => ["Fields"],
    },
  },
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.kms_key #=> String
resp.source_uri #=> String
resp.schedule_configuration.first_execution_from #=> String
resp.schedule_configuration.object #=> String
resp.schedule_configuration.schedule_expression #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.client_token #=> String
resp.file_configuration.folders #=> Array
resp.file_configuration.folders[0] #=> String
resp.file_configuration.filters #=> Hash
resp.file_configuration.filters["NonBlankString"] #=> Array
resp.file_configuration.filters["NonBlankString"][0] #=> String
resp.object_configuration #=> Hash
resp.object_configuration["NonBlankString"] #=> Hash
resp.object_configuration["NonBlankString"]["NonBlankString"] #=> Array
resp.object_configuration["NonBlankString"]["NonBlankString"][0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the DataIntegration.

  • :description (String) —

    A description of the DataIntegration.

  • :kms_key (required, String) —

    The KMS key ARN for the DataIntegration.

  • :source_uri (String) —

    The URI of the data source.

  • :schedule_config (Types::ScheduleConfiguration) —

    The name of the data and how often it should be pulled from the source.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { “tags”: “key2”:“value2” }.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

  • :file_configuration (Types::FileConfiguration) —

    The configuration for what files should be pulled from the source.

  • :object_configuration (Hash<String,Hash>) —

    The configuration for what data should be pulled from the source.

Returns:

See Also:



741
742
743
744
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 741

def create_data_integration(params = {}, options = {})
  req = build_request(:create_data_integration, params)
  req.send_request(options)
end

#create_data_integration_association(params = {}) ⇒ Types::CreateDataIntegrationAssociationResponse

Creates and persists a DataIntegrationAssociation resource.

Examples:

Request syntax with placeholder values


resp = client.create_data_integration_association({
  data_integration_identifier: "Identifier", # required
  client_id: "ClientId",
  object_configuration: {
    "NonBlankString" => {
      "NonBlankString" => ["Fields"],
    },
  },
  destination_uri: "DestinationURI",
  client_association_metadata: {
    "NonBlankString" => "NonBlankString",
  },
  client_token: "IdempotencyToken",
  execution_configuration: {
    execution_mode: "ON_DEMAND", # required, accepts ON_DEMAND, SCHEDULED
    on_demand_configuration: {
      start_time: "NonBlankString", # required
      end_time: "NonBlankString",
    },
    schedule_configuration: {
      first_execution_from: "NonBlankString",
      object: "Object",
      schedule_expression: "NonBlankString", # required
    },
  },
})

Response structure


resp.data_integration_association_id #=> String
resp.data_integration_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_integration_identifier (required, String) —

    A unique identifier for the DataIntegration.

  • :client_id (String) —

    The identifier for the client that is associated with the DataIntegration association.

  • :object_configuration (Hash<String,Hash>) —

    The configuration for what data should be pulled from the source.

  • :destination_uri (String) —

    The URI of the data destination.

  • :client_association_metadata (Hash<String,String>) —

    The mapping of metadata to be extracted from the data.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

  • :execution_configuration (Types::ExecutionConfiguration) —

    The configuration for how the files should be pulled from the source.

Returns:

See Also:



823
824
825
826
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 823

def create_data_integration_association(params = {}, options = {})
  req = build_request(:create_data_integration_association, params)
  req.send_request(options)
end

#create_event_integration(params = {}) ⇒ Types::CreateEventIntegrationResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_event_integration({
  name: "Name", # required
  description: "Description",
  event_filter: { # required
    source: "Source", # required
  },
  event_bridge_bus: "EventBridgeBus", # required
  client_token: "IdempotencyToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.event_integration_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the event integration.

  • :description (String) —

    The description of the event integration.

  • :event_filter (required, Types::EventFilter) —

    The event filter.

  • :event_bridge_bus (required, String) —

    The EventBridge bus.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { “tags”: “key2”:“value2” }.

Returns:

See Also:



891
892
893
894
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 891

def create_event_integration(params = {}, options = {})
  req = build_request(:create_event_integration, params)
  req.send_request(options)
end

#delete_application(params = {}) ⇒ Struct

Deletes the Application. Only Applications that don’t have any Application Associations can be deleted.

Examples:

Example: To delete an application


# The following deletes an application.

resp = client.delete_application({
  arn: "arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_application({
  arn: "ArnOrUUID", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the Application.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



927
928
929
930
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 927

def delete_application(params = {}, options = {})
  req = build_request(:delete_application, params)
  req.send_request(options)
end

#delete_data_integration(params = {}) ⇒ Struct

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.

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html

Examples:

Request syntax with placeholder values


resp = client.delete_data_integration({
  data_integration_identifier: "Identifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_integration_identifier (required, String) —

    A unique identifier for the DataIntegration.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



963
964
965
966
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 963

def delete_data_integration(params = {}, options = {})
  req = build_request(:delete_data_integration, params)
  req.send_request(options)
end

#delete_event_integration(params = {}) ⇒ Struct

Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected.

Examples:

Request syntax with placeholder values


resp = client.delete_event_integration({
  name: "Name", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the event integration.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



986
987
988
989
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 986

def delete_event_integration(params = {}, options = {})
  req = build_request(:delete_event_integration, params)
  req.send_request(options)
end

#get_application(params = {}) ⇒ Types::GetApplicationResponse

Get an Application resource.

Examples:

Example: To get an application


# The following retrives an application.

resp = client.get_application({
  arn: "arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e", 
})

resp.to_h outputs the following:
{
  application_source_config: {
    external_url_config: {
      access_url: "https://example.com", 
    }, 
  }, 
  description: "My first application.", 
  name: "My Application", 
  namespace: "myapplication", 
}

Request syntax with placeholder values


resp = client.get_application({
  arn: "ArnOrUUID", # required
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.name #=> String
resp.namespace #=> String
resp.description #=> String
resp.application_source_config.external_url_config.access_url #=> String
resp.application_source_config.external_url_config.approved_origins #=> Array
resp.application_source_config.external_url_config.approved_origins[0] #=> String
resp.subscriptions #=> Array
resp.subscriptions[0].event #=> String
resp.subscriptions[0].description #=> String
resp.publications #=> Array
resp.publications[0].event #=> String
resp.publications[0].schema #=> String
resp.publications[0].description #=> String
resp.created_time #=> Time
resp.last_modified_time #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.permissions #=> Array
resp.permissions[0] #=> String
resp.is_service #=> Boolean
resp.initialization_timeout #=> Integer
resp.application_config.contact_handling.scope #=> String, one of "CROSS_CONTACTS", "PER_CONTACT"
resp.iframe_config.allow #=> Array
resp.iframe_config.allow[0] #=> String
resp.iframe_config.sandbox #=> Array
resp.iframe_config.sandbox[0] #=> String
resp.application_type #=> String, one of "STANDARD", "SERVICE", "MCP_SERVER"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the Application.

Returns:

See Also:



1079
1080
1081
1082
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1079

def get_application(params = {}, options = {})
  req = build_request(:get_application, params)
  req.send_request(options)
end

#get_data_integration(params = {}) ⇒ Types::GetDataIntegrationResponse

Returns information about the DataIntegration.

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html

Examples:

Request syntax with placeholder values


resp = client.get_data_integration({
  identifier: "Identifier", # required
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.kms_key #=> String
resp.source_uri #=> String
resp.schedule_configuration.first_execution_from #=> String
resp.schedule_configuration.object #=> String
resp.schedule_configuration.schedule_expression #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.file_configuration.folders #=> Array
resp.file_configuration.folders[0] #=> String
resp.file_configuration.filters #=> Hash
resp.file_configuration.filters["NonBlankString"] #=> Array
resp.file_configuration.filters["NonBlankString"][0] #=> String
resp.object_configuration #=> Hash
resp.object_configuration["NonBlankString"] #=> Hash
resp.object_configuration["NonBlankString"]["NonBlankString"] #=> Array
resp.object_configuration["NonBlankString"]["NonBlankString"][0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    A unique identifier.

Returns:

See Also:



1146
1147
1148
1149
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1146

def get_data_integration(params = {}, options = {})
  req = build_request(:get_data_integration, params)
  req.send_request(options)
end

#get_event_integration(params = {}) ⇒ Types::GetEventIntegrationResponse

Returns information about the event integration.

Examples:

Request syntax with placeholder values


resp = client.get_event_integration({
  name: "Name", # required
})

Response structure


resp.name #=> String
resp.description #=> String
resp.event_integration_arn #=> String
resp.event_bridge_bus #=> String
resp.event_filter.source #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the event integration.

Returns:

See Also:



1185
1186
1187
1188
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1185

def get_event_integration(params = {}, options = {})
  req = build_request(:get_event_integration, params)
  req.send_request(options)
end

#list_application_associations(params = {}) ⇒ Types::ListApplicationAssociationsResponse

Returns a paginated list of application associations for an application.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list application associations of an application


# The following retrives application associations of an application

resp = client.list_application_associations({
  application_id: "98542c53-e8ac-4570-9c85-c6552c8d9c5e", 
})

resp.to_h outputs the following:
{
  application_associations: [
    {
      application_arn: "arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e", 
      application_association_arn: "arn:aws:app-integrations:us-west-2:0123456789012:application-association/98542c53-e8ac-4570-9c85-c6552c8d9c5e/461dfb57-320a-454d-9bba-bb560845ff38", 
      client_id: "connect.amazonaws.com", 
    }, 
  ], 
  next_token: "abc", 
}

Request syntax with placeholder values


resp = client.list_application_associations({
  application_id: "ArnOrUUID", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.application_associations #=> Array
resp.application_associations[0].application_association_arn #=> String
resp.application_associations[0].application_arn #=> String
resp.application_associations[0].client_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    A unique identifier for the Application.

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



1252
1253
1254
1255
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1252

def list_application_associations(params = {}, options = {})
  req = build_request(:list_application_associations, params)
  req.send_request(options)
end

#list_applications(params = {}) ⇒ Types::ListApplicationsResponse

Lists applications in the account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list applications in the account


# The following lists application summary in the account.

resp = client.list_applications({
  max_results: 1, 
})

resp.to_h outputs the following:
{
  applications: [
    {
      arn: "arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e", 
      id: "98542c53-e8ac-4570-9c85-c6552c8d9c5e", 
      name: "My Application", 
      namespace: "myapplication", 
    }, 
  ], 
  next_token: "abc", 
}

Request syntax with placeholder values


resp = client.list_applications({
  next_token: "NextToken",
  max_results: 1,
  application_type: "STANDARD", # accepts STANDARD, SERVICE, MCP_SERVER
})

Response structure


resp.applications #=> Array
resp.applications[0].arn #=> String
resp.applications[0].id #=> String
resp.applications[0].name #=> String
resp.applications[0].namespace #=> String
resp.applications[0].created_time #=> Time
resp.applications[0].last_modified_time #=> Time
resp.applications[0].is_service #=> Boolean
resp.applications[0].application_type #=> String, one of "STANDARD", "SERVICE", "MCP_SERVER"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :application_type (String) —

    The type of application.

Returns:

See Also:



1324
1325
1326
1327
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1324

def list_applications(params = {}, options = {})
  req = build_request(:list_applications, params)
  req.send_request(options)
end

#list_data_integration_associations(params = {}) ⇒ Types::ListDataIntegrationAssociationsResponse

Returns a paginated list of DataIntegration associations in the account.

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_integration_associations({
  data_integration_identifier: "Identifier", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.data_integration_associations #=> Array
resp.data_integration_associations[0].data_integration_association_arn #=> String
resp.data_integration_associations[0].data_integration_arn #=> String
resp.data_integration_associations[0].client_id #=> String
resp.data_integration_associations[0].destination_uri #=> String
resp.data_integration_associations[0].last_execution_status.execution_status #=> String, one of "COMPLETED", "IN_PROGRESS", "FAILED"
resp.data_integration_associations[0].last_execution_status.status_message #=> String
resp.data_integration_associations[0].execution_configuration.execution_mode #=> String, one of "ON_DEMAND", "SCHEDULED"
resp.data_integration_associations[0].execution_configuration.on_demand_configuration.start_time #=> String
resp.data_integration_associations[0].execution_configuration.on_demand_configuration.end_time #=> String
resp.data_integration_associations[0].execution_configuration.schedule_configuration.first_execution_from #=> String
resp.data_integration_associations[0].execution_configuration.schedule_configuration.object #=> String
resp.data_integration_associations[0].execution_configuration.schedule_configuration.schedule_expression #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_integration_identifier (required, String) —

    A unique identifier for the DataIntegration.

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



1390
1391
1392
1393
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1390

def list_data_integration_associations(params = {}, options = {})
  req = build_request(:list_data_integration_associations, params)
  req.send_request(options)
end

#list_data_integrations(params = {}) ⇒ Types::ListDataIntegrationsResponse

Returns a paginated list of DataIntegrations in the account.

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_integrations({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.data_integrations #=> Array
resp.data_integrations[0].arn #=> String
resp.data_integrations[0].name #=> String
resp.data_integrations[0].source_uri #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



1442
1443
1444
1445
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1442

def list_data_integrations(params = {}, options = {})
  req = build_request(:list_data_integrations, params)
  req.send_request(options)
end

#list_event_integration_associations(params = {}) ⇒ Types::ListEventIntegrationAssociationsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_event_integration_associations({
  event_integration_name: "Name", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.event_integration_associations #=> Array
resp.event_integration_associations[0].event_integration_association_arn #=> String
resp.event_integration_associations[0].event_integration_association_id #=> String
resp.event_integration_associations[0].event_integration_name #=> String
resp.event_integration_associations[0].client_id #=> String
resp.event_integration_associations[0].event_bridge_rule_name #=> String
resp.event_integration_associations[0].client_association_metadata #=> Hash
resp.event_integration_associations[0].client_association_metadata["NonBlankString"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :event_integration_name (required, String) —

    The name of the event integration.

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



1492
1493
1494
1495
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1492

def list_event_integration_associations(params = {}, options = {})
  req = build_request(:list_event_integration_associations, params)
  req.send_request(options)
end

#list_event_integrations(params = {}) ⇒ Types::ListEventIntegrationsResponse

Returns a paginated list of event integrations in the account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_event_integrations({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.event_integrations #=> Array
resp.event_integrations[0].event_integration_arn #=> String
resp.event_integrations[0].name #=> String
resp.event_integrations[0].description #=> String
resp.event_integrations[0].event_filter.source #=> String
resp.event_integrations[0].event_bridge_bus #=> String
resp.event_integrations[0].tags #=> Hash
resp.event_integrations[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



1537
1538
1539
1540
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1537

def list_event_integrations(params = {}, options = {})
  req = build_request(:list_event_integrations, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags for the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



1566
1567
1568
1569
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1566

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds the specified tags to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tags (required, Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { “tags”: “key2”:“value2” }.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1596
1597
1598
1599
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1596

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the specified tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tag_keys (required, Array<String>) —

    The tag keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1622
1623
1624
1625
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1622

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_application(params = {}) ⇒ Struct

Updates and persists an Application resource.

Examples:

Example: To update an application


# The following updates an existing application named with a new name.

resp = client.update_application({
  arn: "arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e", 
  name: "My New Application Name", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.update_application({
  arn: "ArnOrUUID", # required
  name: "ApplicationName",
  description: "Description",
  application_source_config: {
    external_url_config: {
      access_url: "URL", # required
      approved_origins: ["ApplicationTrustedSource"],
    },
  },
  subscriptions: [
    {
      event: "EventName", # required
      description: "Description",
    },
  ],
  publications: [
    {
      event: "EventName", # required
      schema: "EventDefinitionSchema", # required
      description: "Description",
    },
  ],
  permissions: ["Permission"],
  is_service: false,
  initialization_timeout: 1,
  application_config: {
    contact_handling: {
      scope: "CROSS_CONTACTS", # accepts CROSS_CONTACTS, PER_CONTACT
    },
  },
  iframe_config: {
    allow: ["IframePermission"],
    sandbox: ["IframePermission"],
  },
  application_type: "STANDARD", # accepts STANDARD, SERVICE, MCP_SERVER
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the Application.

  • :name (String) —

    The name of the application.

  • :description (String) —

    The description of the application.

  • :application_source_config (Types::ApplicationSourceConfig) —

    The configuration for where the application should be loaded from.

  • :subscriptions (Array<Types::Subscription>) —

    The events that the application subscribes.

  • :publications (Array<Types::Publication>) —

    The events that the application publishes.

  • :permissions (Array<String>) —

    The configuration of events or requests that the application has access to.

  • :is_service (Boolean) —

    Indicates whether the application is a service.

  • :initialization_timeout (Integer) —

    The maximum time in milliseconds allowed to establish a connection with the workspace.

  • :application_config (Types::ApplicationConfig) —

    The configuration settings for the application.

  • :iframe_config (Types::IframeConfig) —

    The iframe configuration for the application.

  • :application_type (String) —

    The type of application.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1727
1728
1729
1730
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1727

def update_application(params = {}, options = {})
  req = build_request(:update_application, params)
  req.send_request(options)
end

#update_data_integration(params = {}) ⇒ Struct

Updates the description of a DataIntegration.

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html

Examples:

Request syntax with placeholder values


resp = client.update_data_integration({
  identifier: "Identifier", # required
  name: "Name",
  description: "Description",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    A unique identifier for the DataIntegration.

  • :name (String) —

    The name of the DataIntegration.

  • :description (String) —

    A description of the DataIntegration.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1768
1769
1770
1771
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1768

def update_data_integration(params = {}, options = {})
  req = build_request(:update_data_integration, params)
  req.send_request(options)
end

#update_data_integration_association(params = {}) ⇒ Struct

Updates and persists a DataIntegrationAssociation resource.

<note markdown=“1”> Updating a DataIntegrationAssociation with ExecutionConfiguration will rerun the on-demand job.

</note>

Examples:

Request syntax with placeholder values


resp = client.update_data_integration_association({
  data_integration_identifier: "Identifier", # required
  data_integration_association_identifier: "Identifier", # required
  execution_configuration: { # required
    execution_mode: "ON_DEMAND", # required, accepts ON_DEMAND, SCHEDULED
    on_demand_configuration: {
      start_time: "NonBlankString", # required
      end_time: "NonBlankString",
    },
    schedule_configuration: {
      first_execution_from: "NonBlankString",
      object: "Object",
      schedule_expression: "NonBlankString", # required
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_integration_identifier (required, String) —

    A unique identifier for the DataIntegration.

  • :data_integration_association_identifier (required, String) —

    A unique identifier. of the DataIntegrationAssociation resource

  • :execution_configuration (required, Types::ExecutionConfiguration) —

    The configuration for how the files should be pulled from the source.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1814
1815
1816
1817
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1814

def update_data_integration_association(params = {}, options = {})
  req = build_request(:update_data_integration_association, params)
  req.send_request(options)
end

#update_event_integration(params = {}) ⇒ Struct

Updates the description of an event integration.

Examples:

Request syntax with placeholder values


resp = client.update_event_integration({
  name: "Name", # required
  description: "Description",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the event integration.

  • :description (String) —

    The description of the event integration.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1840
1841
1842
1843
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1840

def update_event_integration(params = {}, options = {})
  req = build_request(:update_event_integration, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1869
1870
1871
 
# File 'lib/aws-sdk-appintegrationsservice/client.rb', line 1869

def waiter_names
  []
end