com.amazonaws.services.appfabric

Interface AWSAppFabric

All Known Subinterfaces:

AWSAppFabricAsync

All Known Implementing Classes:

AbstractAWSAppFabric, AbstractAWSAppFabricAsync, AWSAppFabricAsyncClient, AWSAppFabricClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAppFabric

Interface for accessing AppFabric.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSAppFabric instead.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
BatchGetUserAccessTasksResult	batchGetUserAccessTasks(BatchGetUserAccessTasksRequest batchGetUserAccessTasksRequest) Gets user access details in a batch request.
ConnectAppAuthorizationResult	connectAppAuthorization(ConnectAppAuthorizationRequest connectAppAuthorizationRequest) Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application.
CreateAppAuthorizationResult	createAppAuthorization(CreateAppAuthorizationRequest createAppAuthorizationRequest) Creates an app authorization within an app bundle, which allows AppFabric to connect to an application.
CreateAppBundleResult	createAppBundle(CreateAppBundleRequest createAppBundleRequest) Creates an app bundle to collect data from an application using AppFabric.
CreateIngestionResult	createIngestion(CreateIngestionRequest createIngestionRequest) Creates a data ingestion for an application.
CreateIngestionDestinationResult	createIngestionDestination(CreateIngestionDestinationRequest createIngestionDestinationRequest) Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.
DeleteAppAuthorizationResult	deleteAppAuthorization(DeleteAppAuthorizationRequest deleteAppAuthorizationRequest) Deletes an app authorization.
DeleteAppBundleResult	deleteAppBundle(DeleteAppBundleRequest deleteAppBundleRequest) Deletes an app bundle.
DeleteIngestionResult	deleteIngestion(DeleteIngestionRequest deleteIngestionRequest) Deletes an ingestion.
DeleteIngestionDestinationResult	deleteIngestionDestination(DeleteIngestionDestinationRequest deleteIngestionDestinationRequest) Deletes an ingestion destination.
GetAppAuthorizationResult	getAppAuthorization(GetAppAuthorizationRequest getAppAuthorizationRequest) Returns information about an app authorization.
GetAppBundleResult	getAppBundle(GetAppBundleRequest getAppBundleRequest) Returns information about an app bundle.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetIngestionResult	getIngestion(GetIngestionRequest getIngestionRequest) Returns information about an ingestion.
GetIngestionDestinationResult	getIngestionDestination(GetIngestionDestinationRequest getIngestionDestinationRequest) Returns information about an ingestion destination.
ListAppAuthorizationsResult	listAppAuthorizations(ListAppAuthorizationsRequest listAppAuthorizationsRequest) Returns a list of all app authorizations configured for an app bundle.
ListAppBundlesResult	listAppBundles(ListAppBundlesRequest listAppBundlesRequest) Returns a list of app bundles.
ListIngestionDestinationsResult	listIngestionDestinations(ListIngestionDestinationsRequest listIngestionDestinationsRequest) Returns a list of all ingestion destinations configured for an ingestion.
ListIngestionsResult	listIngestions(ListIngestionsRequest listIngestionsRequest) Returns a list of all ingestions configured for an app bundle.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags for a resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartIngestionResult	startIngestion(StartIngestionRequest startIngestionRequest) Starts (enables) an ingestion, which collects data from an application.
StartUserAccessTasksResult	startUserAccessTasks(StartUserAccessTasksRequest startUserAccessTasksRequest) Starts the tasks to search user access status for a specific email address.
StopIngestionResult	stopIngestion(StopIngestionRequest stopIngestionRequest) Stops (disables) an ingestion.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes a tag or tags from a resource.
UpdateAppAuthorizationResult	updateAppAuthorization(UpdateAppAuthorizationRequest updateAppAuthorizationRequest) Updates an app authorization within an app bundle, which allows AppFabric to connect to an application.
UpdateIngestionDestinationResult	updateIngestionDestination(UpdateIngestionDestinationRequest updateIngestionDestinationRequest) Updates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

batchGetUserAccessTasks

BatchGetUserAccessTasksResult batchGetUserAccessTasks(BatchGetUserAccessTasksRequest batchGetUserAccessTasksRequest)

Gets user access details in a batch request.

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

Parameters:

batchGetUserAccessTasksRequest -

Returns:

Result of the BatchGetUserAccessTasks operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

connectAppAuthorization

ConnectAppAuthorizationResult connectAppAuthorization(ConnectAppAuthorizationRequest connectAppAuthorizationRequest)

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

Parameters:

connectAppAuthorizationRequest -

Returns:

Result of the ConnectAppAuthorization operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

createAppAuthorization

CreateAppAuthorizationResult createAppAuthorization(CreateAppAuthorizationRequest createAppAuthorizationRequest)

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

Parameters:

createAppAuthorizationRequest -

Returns:

Result of the CreateAppAuthorization operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ServiceQuotaExceededException - The request exceeds a service quota.

ThrottlingException - The request rate exceeds the limit.

ConflictException - The request has created a conflict. Check the request parameters and try again.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

createAppBundle

CreateAppBundleResult createAppBundle(CreateAppBundleRequest createAppBundleRequest)

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

Parameters:

createAppBundleRequest -

Returns:

Result of the CreateAppBundle operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ServiceQuotaExceededException - The request exceeds a service quota.

ThrottlingException - The request rate exceeds the limit.

ConflictException - The request has created a conflict. Check the request parameters and try again.

ValidationException - The request has invalid or missing parameters.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

createIngestion

CreateIngestionResult createIngestion(CreateIngestionRequest createIngestionRequest)

Creates a data ingestion for an application.

Parameters:

createIngestionRequest -

Returns:

Result of the CreateIngestion operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ServiceQuotaExceededException - The request exceeds a service quota.

ThrottlingException - The request rate exceeds the limit.

ConflictException - The request has created a conflict. Check the request parameters and try again.

ValidationException - The request has invalid or missing parameters.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

createIngestionDestination

CreateIngestionDestinationResult createIngestionDestination(CreateIngestionDestinationRequest createIngestionDestinationRequest)

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

Parameters:

createIngestionDestinationRequest -

Returns:

Result of the CreateIngestionDestination operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ServiceQuotaExceededException - The request exceeds a service quota.

ThrottlingException - The request rate exceeds the limit.

ConflictException - The request has created a conflict. Check the request parameters and try again.

ValidationException - The request has invalid or missing parameters.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

deleteAppAuthorization

DeleteAppAuthorizationResult deleteAppAuthorization(DeleteAppAuthorizationRequest deleteAppAuthorizationRequest)

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

Parameters:

deleteAppAuthorizationRequest -

Returns:

Result of the DeleteAppAuthorization operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

deleteAppBundle

DeleteAppBundleResult deleteAppBundle(DeleteAppBundleRequest deleteAppBundleRequest)

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

Parameters:

deleteAppBundleRequest -

Returns:

Result of the DeleteAppBundle operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ConflictException - The request has created a conflict. Check the request parameters and try again.

ValidationException - The request has invalid or missing parameters.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

deleteIngestion

DeleteIngestionResult deleteIngestion(DeleteIngestionRequest deleteIngestionRequest)

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

Parameters:

deleteIngestionRequest -

Returns:

Result of the DeleteIngestion operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

deleteIngestionDestination

DeleteIngestionDestinationResult deleteIngestionDestination(DeleteIngestionDestinationRequest deleteIngestionDestinationRequest)

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.

Parameters:

deleteIngestionDestinationRequest -

Returns:

Result of the DeleteIngestionDestination operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

getAppAuthorization

GetAppAuthorizationResult getAppAuthorization(GetAppAuthorizationRequest getAppAuthorizationRequest)

Returns information about an app authorization.

Parameters:

getAppAuthorizationRequest -

Returns:

Result of the GetAppAuthorization operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

getAppBundle

GetAppBundleResult getAppBundle(GetAppBundleRequest getAppBundleRequest)

Returns information about an app bundle.

Parameters:

getAppBundleRequest -

Returns:

Result of the GetAppBundle operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

getIngestion

GetIngestionResult getIngestion(GetIngestionRequest getIngestionRequest)

Returns information about an ingestion.

Parameters:

getIngestionRequest -

Returns:

Result of the GetIngestion operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

getIngestionDestination

GetIngestionDestinationResult getIngestionDestination(GetIngestionDestinationRequest getIngestionDestinationRequest)

Returns information about an ingestion destination.

Parameters:

getIngestionDestinationRequest -

Returns:

Result of the GetIngestionDestination operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

listAppAuthorizations

ListAppAuthorizationsResult listAppAuthorizations(ListAppAuthorizationsRequest listAppAuthorizationsRequest)

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

Parameters:

listAppAuthorizationsRequest -

Returns:

Result of the ListAppAuthorizations operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

listAppBundles

ListAppBundlesResult listAppBundles(ListAppBundlesRequest listAppBundlesRequest)

Returns a list of app bundles.

Parameters:

listAppBundlesRequest -

Returns:

Result of the ListAppBundles operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

listIngestionDestinations

ListIngestionDestinationsResult listIngestionDestinations(ListIngestionDestinationsRequest listIngestionDestinationsRequest)

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

Parameters:

listIngestionDestinationsRequest -

Returns:

Result of the ListIngestionDestinations operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

listIngestions

ListIngestionsResult listIngestions(ListIngestionsRequest listIngestionsRequest)

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

Parameters:

listIngestionsRequest -

Returns:

Result of the ListIngestions operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Returns a list of tags for a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

startIngestion

StartIngestionResult startIngestion(StartIngestionRequest startIngestionRequest)

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

Parameters:

startIngestionRequest -

Returns:

Result of the StartIngestion operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ConflictException - The request has created a conflict. Check the request parameters and try again.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

startUserAccessTasks

StartUserAccessTasksResult startUserAccessTasks(StartUserAccessTasksRequest startUserAccessTasksRequest)

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.

Parameters:

startUserAccessTasksRequest -

Returns:

Result of the StartUserAccessTasks operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

stopIngestion

StopIngestionResult stopIngestion(StopIngestionRequest stopIngestionRequest)

Stops (disables) an ingestion.

Parameters:

stopIngestionRequest -

Returns:

Result of the StopIngestion operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ConflictException - The request has created a conflict. Check the request parameters and try again.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes a tag or tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

updateAppAuthorization

UpdateAppAuthorizationResult updateAppAuthorization(UpdateAppAuthorizationRequest updateAppAuthorizationRequest)

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.

Parameters:

updateAppAuthorizationRequest -

Returns:

Result of the UpdateAppAuthorization operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException - The request rate exceeds the limit.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

updateIngestionDestination

UpdateIngestionDestinationResult updateIngestionDestination(UpdateIngestionDestinationRequest updateIngestionDestinationRequest)

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

Parameters:

updateIngestionDestinationRequest -

Returns:

Result of the UpdateIngestionDestination operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure with an internal server.

ServiceQuotaExceededException - The request exceeds a service quota.

ThrottlingException - The request rate exceeds the limit.

ConflictException - The request has created a conflict. Check the request parameters and try again.

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

AccessDeniedException - You are not authorized to perform this operation.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.