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. For more information about using the Command Line Interface (CLI) to manage your AppFabric resources, see the AppFabric section of the CLI Reference.

Usage¶

appfabric(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.
- credentials:
  - creds:
    - access_key_id: AWS access key ID
    - secret_access_key: AWS secret access key
    - session_token: AWS temporary session token
  - profile: The name of a profile to use. If not given, then the default profile is used.
  - anonymous: Set anonymous credentials.
- endpoint: The complete URL to use for the constructed client.
- region: The AWS Region used in instantiating the client.
- close_connection: Immediately close all HTTP connections.
- timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
- 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.
- sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
credentials

Optional credentials shorthand for the config parameter
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

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.

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",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

`batch_get_user_access_tasks`	Gets user access details in a batch request
`connect_app_authorization`	Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application
`create_app_authorization`	Creates an app authorization within an app bundle, which allows AppFabric to connect to an application
`create_app_bundle`	Creates an app bundle to collect data from an application using AppFabric
`create_ingestion`	Creates a data ingestion for an application
`create_ingestion_destination`	Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered
`delete_app_authorization`	Deletes an app authorization
`delete_app_bundle`	Deletes an app bundle
`delete_ingestion`	Deletes an ingestion
`delete_ingestion_destination`	Deletes an ingestion destination
`get_app_authorization`	Returns information about an app authorization
`get_app_bundle`	Returns information about an app bundle
`get_ingestion`	Returns information about an ingestion
`get_ingestion_destination`	Returns information about an ingestion destination
`list_app_authorizations`	Returns a list of all app authorizations configured for an app bundle
`list_app_bundles`	Returns a list of app bundles
`list_ingestion_destinations`	Returns a list of all ingestion destinations configured for an ingestion
`list_ingestions`	Returns a list of all ingestions configured for an app bundle
`list_tags_for_resource`	Returns a list of tags for a resource
`start_ingestion`	Starts (enables) an ingestion, which collects data from an application
`start_user_access_tasks`	Starts the tasks to search user access status for a specific email address
`stop_ingestion`	Stops (disables) an ingestion
`tag_resource`	Assigns one or more tags (key-value pairs) to the specified resource
`untag_resource`	Removes a tag or tags from a resource
`update_app_authorization`	Updates an app authorization within an app bundle, which allows AppFabric to connect to an application
`update_ingestion_destination`	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¶

svc <- appfabric()
svc$batch_get_user_access_tasks(
  Foo = 123
)