R/appfabric_service.R

In paws.networking: 'Amazon Web Services' Networking & Content Delivery Services

# This file is generated by make.paws. Please do not edit here.
#' @importFrom paws.common new_handlers new_service set_config merge_config
NULL

#' AppFabric
#'
#' @description
#' Amazon Web Services AppFabric quickly connects software as a service
#' (SaaS) applications across your organization. This allows IT and
#' security teams to easily manage and secure applications using a standard
#' schema, and employees can complete everyday tasks faster using
#' generative artificial intelligence (AI). You can use these APIs to
#' complete AppFabric tasks, such as setting up audit log ingestions or
#' viewing user access. For more information about AppFabric, including the
#' required permissions to use the service, see the [Amazon Web Services
#' AppFabric Administration
#' Guide](https://docs.aws.amazon.com/appfabric/latest/adminguide/). For
#' more information about using the Command Line Interface (CLI) to manage
#' your AppFabric resources, see the [AppFabric section of the CLI
#' Reference](https://docs.aws.amazon.com/cli/latest/reference/appfabric/).
#'
#' @param
#' config
#' Optional configuration of credentials, endpoint, and/or region.
#' \itemize{
#' \item{\strong{credentials}: \itemize{
#' \item{\strong{creds}: \itemize{
#' \item{\strong{access_key_id}: AWS access key ID}
#' \item{\strong{secret_access_key}: AWS secret access key}
#' \item{\strong{session_token}: AWS temporary session token}
#' }}
#' \item{\strong{profile}: The name of a profile to use. If not given, then the default profile is used.}
#' \item{\strong{anonymous}: Set anonymous credentials.}
#' }}
#' \item{\strong{endpoint}: The complete URL to use for the constructed client.}
#' \item{\strong{region}: The AWS Region used in instantiating the client.}
#' \item{\strong{close_connection}: Immediately close all HTTP connections.}
#' \item{\strong{timeout}: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.}
#' \item{\strong{s3_force_path_style}: Set this to `true` to force the request to use path-style addressing, i.e. `http://s3.amazonaws.com/BUCKET/KEY`.}
#' \item{\strong{sts_regional_endpoint}: Set sts regional endpoint resolver to regional or legacy \url{https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html}}
#' }
#' @param
#' credentials
#' Optional credentials shorthand for the config parameter
#' \itemize{
#' \item{\strong{creds}: \itemize{
#' \item{\strong{access_key_id}: AWS access key ID}
#' \item{\strong{secret_access_key}: AWS secret access key}
#' \item{\strong{session_token}: AWS temporary session token}
#' }}
#' \item{\strong{profile}: The name of a profile to use. If not given, then the default profile is used.}
#' \item{\strong{anonymous}: Set anonymous credentials.}
#' }
#' @param
#' endpoint
#' Optional shorthand for complete URL to use for the constructed client.
#' @param
#' region
#' Optional shorthand for AWS Region used in instantiating the client.
#'
#' @section Service syntax:
#' ```
#' svc <- appfabric(
#'   config = list(
#'     credentials = list(
#'       creds = list(
#'         access_key_id = "string",
#'         secret_access_key = "string",
#'         session_token = "string"
#'       ),
#'       profile = "string",
#'       anonymous = "logical"
#'     ),
#'     endpoint = "string",
#'     region = "string",
#'     close_connection = "logical",
#'     timeout = "numeric",
#'     s3_force_path_style = "logical",
#'     sts_regional_endpoint = "string"
#'   ),
#'   credentials = list(
#'     creds = list(
#'       access_key_id = "string",
#'       secret_access_key = "string",
#'       session_token = "string"
#'     ),
#'     profile = "string",
#'     anonymous = "logical"
#'   ),
#'   endpoint = "string",
#'   region = "string"
#' )
#' ```
#'
#' @examples
#' \dontrun{
#' svc <- appfabric()
#' svc$batch_get_user_access_tasks(
#'   Foo = 123
#' )
#' }
#'
#' @section Operations:
#' \tabular{ll}{
#'  \link[=appfabric_batch_get_user_access_tasks]{batch_get_user_access_tasks} \tab Gets user access details in a batch request\cr
#'  \link[=appfabric_connect_app_authorization]{connect_app_authorization} \tab Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application\cr
#'  \link[=appfabric_create_app_authorization]{create_app_authorization} \tab Creates an app authorization within an app bundle, which allows AppFabric to connect to an application\cr
#'  \link[=appfabric_create_app_bundle]{create_app_bundle} \tab Creates an app bundle to collect data from an application using AppFabric\cr
#'  \link[=appfabric_create_ingestion]{create_ingestion} \tab Creates a data ingestion for an application\cr
#'  \link[=appfabric_create_ingestion_destination]{create_ingestion_destination} \tab Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered\cr
#'  \link[=appfabric_delete_app_authorization]{delete_app_authorization} \tab Deletes an app authorization\cr
#'  \link[=appfabric_delete_app_bundle]{delete_app_bundle} \tab Deletes an app bundle\cr
#'  \link[=appfabric_delete_ingestion]{delete_ingestion} \tab Deletes an ingestion\cr
#'  \link[=appfabric_delete_ingestion_destination]{delete_ingestion_destination} \tab Deletes an ingestion destination\cr
#'  \link[=appfabric_get_app_authorization]{get_app_authorization} \tab Returns information about an app authorization\cr
#'  \link[=appfabric_get_app_bundle]{get_app_bundle} \tab Returns information about an app bundle\cr
#'  \link[=appfabric_get_ingestion]{get_ingestion} \tab Returns information about an ingestion\cr
#'  \link[=appfabric_get_ingestion_destination]{get_ingestion_destination} \tab Returns information about an ingestion destination\cr
#'  \link[=appfabric_list_app_authorizations]{list_app_authorizations} \tab Returns a list of all app authorizations configured for an app bundle\cr
#'  \link[=appfabric_list_app_bundles]{list_app_bundles} \tab Returns a list of app bundles\cr
#'  \link[=appfabric_list_ingestion_destinations]{list_ingestion_destinations} \tab Returns a list of all ingestion destinations configured for an ingestion\cr
#'  \link[=appfabric_list_ingestions]{list_ingestions} \tab Returns a list of all ingestions configured for an app bundle\cr
#'  \link[=appfabric_list_tags_for_resource]{list_tags_for_resource} \tab Returns a list of tags for a resource\cr
#'  \link[=appfabric_start_ingestion]{start_ingestion} \tab Starts (enables) an ingestion, which collects data from an application\cr
#'  \link[=appfabric_start_user_access_tasks]{start_user_access_tasks} \tab Starts the tasks to search user access status for a specific email address\cr
#'  \link[=appfabric_stop_ingestion]{stop_ingestion} \tab Stops (disables) an ingestion\cr
#'  \link[=appfabric_tag_resource]{tag_resource} \tab Assigns one or more tags (key-value pairs) to the specified resource\cr
#'  \link[=appfabric_untag_resource]{untag_resource} \tab Removes a tag or tags from a resource\cr
#'  \link[=appfabric_update_app_authorization]{update_app_authorization} \tab Updates an app authorization within an app bundle, which allows AppFabric to connect to an application\cr
#'  \link[=appfabric_update_ingestion_destination]{update_ingestion_destination} \tab Updates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered
#' }
#'
#' @return
#' A client for the service. You can call the service's operations using
#' syntax like `svc$operation(...)`, where `svc` is the name you've assigned
#' to the client. The available operations are listed in the
#' Operations section.
#'
#' @rdname appfabric
#' @export
appfabric <- function(config = list(), credentials = list(), endpoint = NULL, region = NULL) {
  config <- merge_config(
    config,
    list(
      credentials = credentials,
      endpoint = endpoint,
      region = region
    )
  )
  svc <- .appfabric$operations
  svc <- set_config(svc, config)
  return(svc)
}

# Private API objects: metadata, handlers, interfaces, etc.
.appfabric <- list()

.appfabric$operations <- list()

.appfabric$metadata <- list(
  service_name = "appfabric",
  endpoints = list("*" = list(endpoint = "appfabric.{region}.amazonaws.com", global = FALSE), "cn-*" = list(endpoint = "appfabric.{region}.amazonaws.com.cn", global = FALSE), "eu-isoe-*" = list(endpoint = "appfabric.{region}.cloud.adc-e.uk", global = FALSE), "us-iso-*" = list(endpoint = "appfabric.{region}.c2s.ic.gov", global = FALSE), "us-isob-*" = list(endpoint = "appfabric.{region}.sc2s.sgov.gov", global = FALSE), "us-isof-*" = list(endpoint = "appfabric.{region}.csp.hci.ic.gov", global = FALSE)),
  service_id = "AppFabric",
  api_version = "2023-05-19",
  signing_name = "appfabric",
  json_version = "1.1",
  target_prefix = ""
)

.appfabric$service <- function(config = list(), op = NULL) {
  handlers <- new_handlers("restjson", "v4")
  new_service(.appfabric$metadata, handlers, config, op)
}