Class: Aws::AppFabric::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb

Overview

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

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

For details on configuring region and credentials see the developer guide.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

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[:credentials]

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

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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['AWS_EC2_METADATA_DISABLED'] 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:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :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['AWS_AUTH_SCHEME_PREFERENCE'] 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. Takes effect only when disable_clock_skew_correction is not set.

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

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

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :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 https://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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

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

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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::AppFabric::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::AppFabric::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 'http://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.



478
479
480
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 478

def initialize(*args)
  super
end

Instance Method Details

#batch_get_user_access_tasks(params = {}) ⇒ Types::BatchGetUserAccessTasksResponse

Gets user access details in a batch request.

This action polls data from the tasks that are kicked off by the StartUserAccessTasks action.

Examples:

Request syntax with placeholder values


resp = client.batch_get_user_access_tasks({
  app_bundle_identifier: "Identifier", # required
  task_id_list: ["UUID"], # required
})

Response structure


resp.user_access_results_list #=> Array
resp.user_access_results_list[0].app #=> String
resp.user_access_results_list[0].tenant_id #=> String
resp.user_access_results_list[0].tenant_display_name #=> String
resp.user_access_results_list[0].task_id #=> String
resp.user_access_results_list[0].result_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED", "EXPIRED"
resp.user_access_results_list[0].email #=> String
resp.user_access_results_list[0].user_id #=> String
resp.user_access_results_list[0].user_full_name #=> String
resp.user_access_results_list[0].user_first_name #=> String
resp.user_access_results_list[0].user_last_name #=> String
resp.user_access_results_list[0].user_status #=> String
resp.user_access_results_list[0].task_error.error_code #=> String
resp.user_access_results_list[0].task_error.error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

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

    The tasks IDs to use for the request.

Returns:

See Also:



528
529
530
531
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 528

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

#connect_app_authorization(params = {}) ⇒ Types::ConnectAppAuthorizationResponse

Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application.

Examples:

Request syntax with placeholder values


resp = client.connect_app_authorization({
  app_bundle_identifier: "Identifier", # required
  app_authorization_identifier: "Identifier", # required
  auth_request: {
    redirect_uri: "RedirectUri", # required
    code: "SensitiveString2048", # required
  },
})

Response structure


resp.app_authorization_summary.app_authorization_arn #=> String
resp.app_authorization_summary.app_bundle_arn #=> String
resp.app_authorization_summary.app #=> String
resp.app_authorization_summary.tenant.tenant_identifier #=> String
resp.app_authorization_summary.tenant.tenant_display_name #=> String
resp.app_authorization_summary.status #=> String, one of "PendingConnect", "Connected", "ConnectionValidationFailed", "TokenAutoRotationFailed"
resp.app_authorization_summary.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle that contains the app authorization to use for the request.

  • :app_authorization_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.

  • :auth_request (Types::AuthRequest) —

    Contains OAuth2 authorization information.

    This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.

Returns:

See Also:



581
582
583
584
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 581

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

#create_app_authorization(params = {}) ⇒ Types::CreateAppAuthorizationResponse

Creates an app authorization within an app bundle, which allows AppFabric to connect to an application.

Examples:

Request syntax with placeholder values


resp = client.create_app_authorization({
  app_bundle_identifier: "Identifier", # required
  app: "String255", # required
  credential: { # required
    oauth2_credential: {
      client_id: "String2048", # required
      client_secret: "SensitiveString2048", # required
    },
    api_key_credential: {
      api_key: "SensitiveString2048", # required
    },
  },
  tenant: { # required
    tenant_identifier: "TenantIdentifier", # required
    tenant_display_name: "String2048", # required
  },
  auth_type: "oauth2", # required, accepts oauth2, apiKey
  client_token: "UUID",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.app_authorization.app_authorization_arn #=> String
resp.app_authorization.app_bundle_arn #=> String
resp.app_authorization.app #=> String
resp.app_authorization.tenant.tenant_identifier #=> String
resp.app_authorization.tenant.tenant_display_name #=> String
resp.app_authorization.auth_type #=> String, one of "oauth2", "apiKey"
resp.app_authorization.status #=> String, one of "PendingConnect", "Connected", "ConnectionValidationFailed", "TokenAutoRotationFailed"
resp.app_authorization.created_at #=> Time
resp.app_authorization.updated_at #=> Time
resp.app_authorization.persona #=> String, one of "admin", "endUser"
resp.app_authorization.auth_url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • :app (required, String) —

    The name of the application.

    Valid values are:

    • SLACK

    • ASANA

    • JIRA

    • M365

    • M365AUDITLOGS

    • ZOOM

    • ZENDESK

    • OKTA

    • GOOGLE

    • DROPBOX

    • SMARTSHEET

    • CISCO

  • :credential (required, Types::Credential) —

    Contains credentials for the application, such as an API key or OAuth2 client ID and secret.

    Specify credentials that match the authorization type for your request. For example, if the authorization type for your request is OAuth2 (oauth2), then you should provide only the OAuth2 credentials.

  • :tenant (required, Types::Tenant) —

    Contains information about an application tenant, such as the application display name and identifier.

  • :auth_type (required, String) —

    The authorization type for the app authorization.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

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

  • :tags (Array<Types::Tag>) —

    A map of the key-value pairs of the tag or tags to assign to the resource.

Returns:

See Also:



714
715
716
717
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 714

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

#create_app_bundle(params = {}) ⇒ Types::CreateAppBundleResponse

Creates an app bundle to collect data from an application using AppFabric.

Examples:

Request syntax with placeholder values


resp = client.create_app_bundle({
  client_token: "UUID",
  customer_managed_key_identifier: "Identifier",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.app_bundle.arn #=> String
resp.app_bundle.customer_managed_key_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

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

  • :customer_managed_key_identifier (String) —

    The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use to encrypt the application data. If this is not specified, an Amazon Web Services owned key is used for encryption.

  • :tags (Array<Types::Tag>) —

    A map of the key-value pairs of the tag or tags to assign to the resource.

Returns:

See Also:



779
780
781
782
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 779

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

#create_ingestion(params = {}) ⇒ Types::CreateIngestionResponse

Creates a data ingestion for an application.

Examples:

Request syntax with placeholder values


resp = client.create_ingestion({
  app_bundle_identifier: "Identifier", # required
  app: "String255", # required
  tenant_id: "TenantIdentifier", # required
  ingestion_type: "auditLog", # required, accepts auditLog
  client_token: "UUID",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.ingestion.arn #=> String
resp.ingestion.app_bundle_arn #=> String
resp.ingestion.app #=> String
resp.ingestion.tenant_id #=> String
resp.ingestion.created_at #=> Time
resp.ingestion.updated_at #=> Time
resp.ingestion.state #=> String, one of "enabled", "disabled"
resp.ingestion.ingestion_type #=> String, one of "auditLog"

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • :app (required, String) —

    The name of the application.

    Valid values are:

    • SLACK

    • ASANA

    • JIRA

    • M365

    • M365AUDITLOGS

    • ZOOM

    • ZENDESK

    • OKTA

    • GOOGLE

    • DROPBOX

    • SMARTSHEET

    • CISCO

  • :tenant_id (required, String) —

    The ID of the application tenant.

  • :ingestion_type (required, String) —

    The ingestion type.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

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

  • :tags (Array<Types::Tag>) —

    A map of the key-value pairs of the tag or tags to assign to the resource.

Returns:

See Also:



886
887
888
889
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 886

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

#create_ingestion_destination(params = {}) ⇒ Types::CreateIngestionDestinationResponse

Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.

Examples:

Request syntax with placeholder values


resp = client.create_ingestion_destination({
  app_bundle_identifier: "Identifier", # required
  ingestion_identifier: "Identifier", # required
  processing_configuration: { # required
    audit_log: {
      schema: "ocsf", # required, accepts ocsf, raw
      format: "json", # required, accepts json, parquet
    },
  },
  destination_configuration: { # required
    audit_log: {
      destination: { # required
        s3_bucket: {
          bucket_name: "String63", # required
          prefix: "String120",
        },
        firehose_stream: {
          stream_name: "String64", # required
        },
      },
    },
  },
  client_token: "UUID",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.ingestion_destination.arn #=> String
resp.ingestion_destination.ingestion_arn #=> String
resp.ingestion_destination.processing_configuration.audit_log.schema #=> String, one of "ocsf", "raw"
resp.ingestion_destination.processing_configuration.audit_log.format #=> String, one of "json", "parquet"
resp.ingestion_destination.destination_configuration.audit_log.destination.s3_bucket.bucket_name #=> String
resp.ingestion_destination.destination_configuration.audit_log.destination.s3_bucket.prefix #=> String
resp.ingestion_destination.destination_configuration.audit_log.destination.firehose_stream.stream_name #=> String
resp.ingestion_destination.status #=> String, one of "Active", "Failed"
resp.ingestion_destination.status_reason #=> String
resp.ingestion_destination.created_at #=> Time
resp.ingestion_destination.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • :ingestion_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

  • :processing_configuration (required, Types::ProcessingConfiguration) —

    Contains information about how ingested data is processed.

  • :destination_configuration (required, Types::DestinationConfiguration) —

    Contains information about the destination of ingested data.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

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

  • :tags (Array<Types::Tag>) —

    A map of the key-value pairs of the tag or tags to assign to the resource.

Returns:

See Also:



990
991
992
993
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 990

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

#delete_app_authorization(params = {}) ⇒ Struct

Deletes an app authorization. You must delete the associated ingestion before you can delete an app authorization.

Examples:

Request syntax with placeholder values


resp = client.delete_app_authorization({
  app_bundle_identifier: "Identifier", # required
  app_authorization_identifier: "Identifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • :app_authorization_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1019
1020
1021
1022
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1019

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

#delete_app_bundle(params = {}) ⇒ Struct

Deletes an app bundle. You must delete all associated app authorizations before you can delete an app bundle.

Examples:

Request syntax with placeholder values


resp = client.delete_app_bundle({
  app_bundle_identifier: "Identifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The ID or Amazon Resource Name (ARN) of the app bundle that needs to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1043
1044
1045
1046
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1043

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

#delete_ingestion(params = {}) ⇒ Struct

Deletes an ingestion. You must stop (disable) the ingestion and you must delete all associated ingestion destinations before you can delete an app ingestion.

Examples:

Request syntax with placeholder values


resp = client.delete_ingestion({
  app_bundle_identifier: "Identifier", # required
  ingestion_identifier: "Identifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • :ingestion_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1073
1074
1075
1076
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1073

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

#delete_ingestion_destination(params = {}) ⇒ Struct

Deletes an ingestion destination.

This deletes the association between an ingestion and it's destination. It doesn't delete previously ingested data or the storage destination, such as the Amazon S3 bucket where the data is delivered. If the ingestion destination is deleted while the associated ingestion is enabled, the ingestion will fail and is eventually disabled.

Examples:

Request syntax with placeholder values


resp = client.delete_ingestion_destination({
  app_bundle_identifier: "Identifier", # required
  ingestion_identifier: "Identifier", # required
  ingestion_destination_identifier: "Identifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • :ingestion_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

  • :ingestion_destination_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1113
1114
1115
1116
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1113

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

#get_app_authorization(params = {}) ⇒ Types::GetAppAuthorizationResponse

Returns information about an app authorization.

Examples:

Request syntax with placeholder values


resp = client.get_app_authorization({
  app_bundle_identifier: "Identifier", # required
  app_authorization_identifier: "Identifier", # required
})

Response structure


resp.app_authorization.app_authorization_arn #=> String
resp.app_authorization.app_bundle_arn #=> String
resp.app_authorization.app #=> String
resp.app_authorization.tenant.tenant_identifier #=> String
resp.app_authorization.tenant.tenant_display_name #=> String
resp.app_authorization.auth_type #=> String, one of "oauth2", "apiKey"
resp.app_authorization.status #=> String, one of "PendingConnect", "Connected", "ConnectionValidationFailed", "TokenAutoRotationFailed"
resp.app_authorization.created_at #=> Time
resp.app_authorization.updated_at #=> Time
resp.app_authorization.persona #=> String, one of "admin", "endUser"
resp.app_authorization.auth_url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • :app_authorization_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.

Returns:

See Also:



1157
1158
1159
1160
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1157

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

#get_app_bundle(params = {}) ⇒ Types::GetAppBundleResponse

Returns information about an app bundle.

Examples:

Request syntax with placeholder values


resp = client.get_app_bundle({
  app_bundle_identifier: "Identifier", # required
})

Response structure


resp.app_bundle.arn #=> String
resp.app_bundle.customer_managed_key_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

Returns:

See Also:



1187
1188
1189
1190
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1187

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

#get_ingestion(params = {}) ⇒ Types::GetIngestionResponse

Returns information about an ingestion.

Examples:

Request syntax with placeholder values


resp = client.get_ingestion({
  app_bundle_identifier: "Identifier", # required
  ingestion_identifier: "Identifier", # required
})

Response structure


resp.ingestion.arn #=> String
resp.ingestion.app_bundle_arn #=> String
resp.ingestion.app #=> String
resp.ingestion.tenant_id #=> String
resp.ingestion.created_at #=> Time
resp.ingestion.updated_at #=> Time
resp.ingestion.state #=> String, one of "enabled", "disabled"
resp.ingestion.ingestion_type #=> String, one of "auditLog"

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • :ingestion_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

Returns:

See Also:



1228
1229
1230
1231
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1228

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

#get_ingestion_destination(params = {}) ⇒ Types::GetIngestionDestinationResponse

Returns information about an ingestion destination.

Examples:

Request syntax with placeholder values


resp = client.get_ingestion_destination({
  app_bundle_identifier: "Identifier", # required
  ingestion_identifier: "Identifier", # required
  ingestion_destination_identifier: "Identifier", # required
})

Response structure


resp.ingestion_destination.arn #=> String
resp.ingestion_destination.ingestion_arn #=> String
resp.ingestion_destination.processing_configuration.audit_log.schema #=> String, one of "ocsf", "raw"
resp.ingestion_destination.processing_configuration.audit_log.format #=> String, one of "json", "parquet"
resp.ingestion_destination.destination_configuration.audit_log.destination.s3_bucket.bucket_name #=> String
resp.ingestion_destination.destination_configuration.audit_log.destination.s3_bucket.prefix #=> String
resp.ingestion_destination.destination_configuration.audit_log.destination.firehose_stream.stream_name #=> String
resp.ingestion_destination.status #=> String, one of "Active", "Failed"
resp.ingestion_destination.status_reason #=> String
resp.ingestion_destination.created_at #=> Time
resp.ingestion_destination.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • :ingestion_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

  • :ingestion_destination_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.

Returns:

See Also:



1277
1278
1279
1280
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1277

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

#list_app_authorizations(params = {}) ⇒ Types::ListAppAuthorizationsResponse

Returns a list of all app authorizations configured for an app bundle.

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_app_authorizations({
  app_bundle_identifier: "Identifier", # required
  max_results: 1,
  next_token: "String2048",
})

Response structure


resp.app_authorization_summary_list #=> Array
resp.app_authorization_summary_list[0].app_authorization_arn #=> String
resp.app_authorization_summary_list[0].app_bundle_arn #=> String
resp.app_authorization_summary_list[0].app #=> String
resp.app_authorization_summary_list[0].tenant.tenant_identifier #=> String
resp.app_authorization_summary_list[0].tenant.tenant_display_name #=> String
resp.app_authorization_summary_list[0].status #=> String, one of "PendingConnect", "Connected", "ConnectionValidationFailed", "TokenAutoRotationFailed"
resp.app_authorization_summary_list[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • :max_results (Integer) —

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

  • :next_token (String) —

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

See Also:



1334
1335
1336
1337
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1334

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

#list_app_bundles(params = {}) ⇒ Types::ListAppBundlesResponse

Returns a list of app bundles.

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_app_bundles({
  max_results: 1,
  next_token: "String2048",
})

Response structure


resp.app_bundle_summary_list #=> Array
resp.app_bundle_summary_list[0].arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

  • :next_token (String) —

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

See Also:



1380
1381
1382
1383
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1380

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

#list_ingestion_destinations(params = {}) ⇒ Types::ListIngestionDestinationsResponse

Returns a list of all ingestion destinations configured for an ingestion.

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_ingestion_destinations({
  app_bundle_identifier: "Identifier", # required
  ingestion_identifier: "Identifier", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.ingestion_destinations #=> Array
resp.ingestion_destinations[0].arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • :ingestion_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

  • :max_results (Integer) —

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

  • :next_token (String) —

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

See Also:



1437
1438
1439
1440
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1437

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

#list_ingestions(params = {}) ⇒ Types::ListIngestionsResponse

Returns a list of all ingestions configured for an app bundle.

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_ingestions({
  app_bundle_identifier: "Identifier", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.ingestions #=> Array
resp.ingestions[0].arn #=> String
resp.ingestions[0].app #=> String
resp.ingestions[0].tenant_id #=> String
resp.ingestions[0].state #=> String, one of "enabled", "disabled"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • :max_results (Integer) —

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

  • :next_token (String) —

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

See Also:



1491
1492
1493
1494
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1491

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

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

Returns a list of tags for a resource.

Examples:

Request syntax with placeholder values


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

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.

Returns:

See Also:



1522
1523
1524
1525
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1522

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

#start_ingestion(params = {}) ⇒ Struct

Starts (enables) an ingestion, which collects data from an application.

Examples:

Request syntax with placeholder values


resp = client.start_ingestion({
  ingestion_identifier: "Identifier", # required
  app_bundle_identifier: "Identifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :ingestion_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1551
1552
1553
1554
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1551

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

#start_user_access_tasks(params = {}) ⇒ Types::StartUserAccessTasksResponse

Starts the tasks to search user access status for a specific email address.

The tasks are stopped when the user access status data is found. The tasks are terminated when the API calls to the application time out.

Examples:

Request syntax with placeholder values


resp = client.start_user_access_tasks({
  app_bundle_identifier: "Identifier", # required
  email: "Email", # required
})

Response structure


resp.user_access_tasks_list #=> Array
resp.user_access_tasks_list[0].app #=> String
resp.user_access_tasks_list[0].tenant_id #=> String
resp.user_access_tasks_list[0].task_id #=> String
resp.user_access_tasks_list[0].error.error_code #=> String
resp.user_access_tasks_list[0].error.error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • :email (required, String) —

    The email address of the target user.

Returns:

See Also:



1593
1594
1595
1596
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1593

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

#stop_ingestion(params = {}) ⇒ Struct

Stops (disables) an ingestion.

Examples:

Request syntax with placeholder values


resp = client.stop_ingestion({
  ingestion_identifier: "Identifier", # required
  app_bundle_identifier: "Identifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :ingestion_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1621
1622
1623
1624
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1621

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

#tag_resource(params = {}) ⇒ Struct

Assigns one or more tags (key-value pairs) to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to tag.

  • :tags (required, Array<Types::Tag>) —

    A map of the key-value pairs of the tag or tags to assign to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1653
1654
1655
1656
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1653

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

#untag_resource(params = {}) ⇒ Struct

Removes a tag or tags from a 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 that you want to untag.

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

    The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1680
1681
1682
1683
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1680

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

#update_app_authorization(params = {}) ⇒ Types::UpdateAppAuthorizationResponse

Updates an app authorization within an app bundle, which allows AppFabric to connect to an application.

If the app authorization was in a connected state, updating the app authorization will set it back to a PendingConnect state.

Examples:

Request syntax with placeholder values


resp = client.update_app_authorization({
  app_bundle_identifier: "Identifier", # required
  app_authorization_identifier: "Identifier", # required
  credential: {
    oauth2_credential: {
      client_id: "String2048", # required
      client_secret: "SensitiveString2048", # required
    },
    api_key_credential: {
      api_key: "SensitiveString2048", # required
    },
  },
  tenant: {
    tenant_identifier: "TenantIdentifier", # required
    tenant_display_name: "String2048", # required
  },
})

Response structure


resp.app_authorization.app_authorization_arn #=> String
resp.app_authorization.app_bundle_arn #=> String
resp.app_authorization.app #=> String
resp.app_authorization.tenant.tenant_identifier #=> String
resp.app_authorization.tenant.tenant_display_name #=> String
resp.app_authorization.auth_type #=> String, one of "oauth2", "apiKey"
resp.app_authorization.status #=> String, one of "PendingConnect", "Connected", "ConnectionValidationFailed", "TokenAutoRotationFailed"
resp.app_authorization.created_at #=> Time
resp.app_authorization.updated_at #=> Time
resp.app_authorization.persona #=> String, one of "admin", "endUser"
resp.app_authorization.auth_url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • :app_authorization_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.

  • :credential (Types::Credential) —

    Contains credentials for the application, such as an API key or OAuth2 client ID and secret.

    Specify credentials that match the authorization type of the app authorization to update. For example, if the authorization type of the app authorization is OAuth2 (oauth2), then you should provide only the OAuth2 credentials.

  • :tenant (Types::Tenant) —

    Contains information about an application tenant, such as the application display name and identifier.

Returns:

See Also:



1754
1755
1756
1757
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1754

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

#update_ingestion_destination(params = {}) ⇒ Types::UpdateIngestionDestinationResponse

Updates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.

Examples:

Request syntax with placeholder values


resp = client.update_ingestion_destination({
  app_bundle_identifier: "Identifier", # required
  ingestion_identifier: "Identifier", # required
  ingestion_destination_identifier: "Identifier", # required
  destination_configuration: { # required
    audit_log: {
      destination: { # required
        s3_bucket: {
          bucket_name: "String63", # required
          prefix: "String120",
        },
        firehose_stream: {
          stream_name: "String64", # required
        },
      },
    },
  },
})

Response structure


resp.ingestion_destination.arn #=> String
resp.ingestion_destination.ingestion_arn #=> String
resp.ingestion_destination.processing_configuration.audit_log.schema #=> String, one of "ocsf", "raw"
resp.ingestion_destination.processing_configuration.audit_log.format #=> String, one of "json", "parquet"
resp.ingestion_destination.destination_configuration.audit_log.destination.s3_bucket.bucket_name #=> String
resp.ingestion_destination.destination_configuration.audit_log.destination.s3_bucket.prefix #=> String
resp.ingestion_destination.destination_configuration.audit_log.destination.firehose_stream.stream_name #=> String
resp.ingestion_destination.status #=> String, one of "Active", "Failed"
resp.ingestion_destination.status_reason #=> String
resp.ingestion_destination.created_at #=> Time
resp.ingestion_destination.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :app_bundle_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • :ingestion_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

  • :ingestion_destination_identifier (required, String) —

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.

  • :destination_configuration (required, Types::DestinationConfiguration) —

    Contains information about the destination of ingested data.

Returns:

See Also:



1821
1822
1823
1824
 
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1821

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