Class: Aws::AppFabric::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AppFabric::Client
- 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
API Operations collapse
-
#batch_get_user_access_tasks(params = {}) ⇒ Types::BatchGetUserAccessTasksResponse
Gets user access details in a batch request.
-
#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.
-
#create_app_authorization(params = {}) ⇒ Types::CreateAppAuthorizationResponse
Creates an app authorization within an app bundle, which allows AppFabric to connect to an application.
-
#create_app_bundle(params = {}) ⇒ Types::CreateAppBundleResponse
Creates an app bundle to collect data from an application using AppFabric.
-
#create_ingestion(params = {}) ⇒ Types::CreateIngestionResponse
Creates a data ingestion for an application.
-
#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.
-
#delete_app_authorization(params = {}) ⇒ Struct
Deletes an app authorization.
-
#delete_app_bundle(params = {}) ⇒ Struct
Deletes an app bundle.
-
#delete_ingestion(params = {}) ⇒ Struct
Deletes an ingestion.
-
#delete_ingestion_destination(params = {}) ⇒ Struct
Deletes an ingestion destination.
-
#get_app_authorization(params = {}) ⇒ Types::GetAppAuthorizationResponse
Returns information about an app authorization.
-
#get_app_bundle(params = {}) ⇒ Types::GetAppBundleResponse
Returns information about an app bundle.
-
#get_ingestion(params = {}) ⇒ Types::GetIngestionResponse
Returns information about an ingestion.
-
#get_ingestion_destination(params = {}) ⇒ Types::GetIngestionDestinationResponse
Returns information about an ingestion destination.
-
#list_app_authorizations(params = {}) ⇒ Types::ListAppAuthorizationsResponse
Returns a list of all app authorizations configured for an app bundle.
-
#list_app_bundles(params = {}) ⇒ Types::ListAppBundlesResponse
Returns a list of app bundles.
-
#list_ingestion_destinations(params = {}) ⇒ Types::ListIngestionDestinationsResponse
Returns a list of all ingestion destinations configured for an ingestion.
-
#list_ingestions(params = {}) ⇒ Types::ListIngestionsResponse
Returns a list of all ingestions configured for an app bundle.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags for a resource.
-
#start_ingestion(params = {}) ⇒ Struct
Starts (enables) an ingestion, which collects data from an application.
-
#start_user_access_tasks(params = {}) ⇒ Types::StartUserAccessTasksResponse
Starts the tasks to search user access status for a specific email address.
-
#stop_ingestion(params = {}) ⇒ Struct
Stops (disables) an ingestion.
-
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag or tags from a resource.
-
#update_app_authorization(params = {}) ⇒ Types::UpdateAppAuthorizationResponse
Updates an app authorization within an app bundle, which allows AppFabric to connect to an application.
-
#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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
410 411 412 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 410 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.
460 461 462 463 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 460 def batch_get_user_access_tasks(params = {}, = {}) req = build_request(:batch_get_user_access_tasks, params) req.send_request() 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.
513 514 515 516 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 513 def (params = {}, = {}) req = build_request(:connect_app_authorization, params) req.send_request() end |
#create_app_authorization(params = {}) ⇒ Types::CreateAppAuthorizationResponse
Creates an app authorization within an app bundle, which allows AppFabric to connect to an application.
646 647 648 649 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 646 def (params = {}, = {}) req = build_request(:create_app_authorization, params) req.send_request() end |
#create_app_bundle(params = {}) ⇒ Types::CreateAppBundleResponse
Creates an app bundle to collect data from an application using AppFabric.
711 712 713 714 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 711 def create_app_bundle(params = {}, = {}) req = build_request(:create_app_bundle, params) req.send_request() end |
#create_ingestion(params = {}) ⇒ Types::CreateIngestionResponse
Creates a data ingestion for an application.
818 819 820 821 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 818 def create_ingestion(params = {}, = {}) req = build_request(:create_ingestion, params) req.send_request() 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.
922 923 924 925 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 922 def create_ingestion_destination(params = {}, = {}) req = build_request(:create_ingestion_destination, params) req.send_request() end |
#delete_app_authorization(params = {}) ⇒ Struct
Deletes an app authorization. You must delete the associated ingestion before you can delete an app authorization.
951 952 953 954 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 951 def (params = {}, = {}) req = build_request(:delete_app_authorization, params) req.send_request() end |
#delete_app_bundle(params = {}) ⇒ Struct
Deletes an app bundle. You must delete all associated app authorizations before you can delete an app bundle.
975 976 977 978 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 975 def delete_app_bundle(params = {}, = {}) req = build_request(:delete_app_bundle, params) req.send_request() 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.
1005 1006 1007 1008 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1005 def delete_ingestion(params = {}, = {}) req = build_request(:delete_ingestion, params) req.send_request() 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.
1045 1046 1047 1048 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1045 def delete_ingestion_destination(params = {}, = {}) req = build_request(:delete_ingestion_destination, params) req.send_request() end |
#get_app_authorization(params = {}) ⇒ Types::GetAppAuthorizationResponse
Returns information about an app authorization.
1089 1090 1091 1092 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1089 def (params = {}, = {}) req = build_request(:get_app_authorization, params) req.send_request() end |
#get_app_bundle(params = {}) ⇒ Types::GetAppBundleResponse
Returns information about an app bundle.
1119 1120 1121 1122 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1119 def get_app_bundle(params = {}, = {}) req = build_request(:get_app_bundle, params) req.send_request() end |
#get_ingestion(params = {}) ⇒ Types::GetIngestionResponse
Returns information about an ingestion.
1160 1161 1162 1163 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1160 def get_ingestion(params = {}, = {}) req = build_request(:get_ingestion, params) req.send_request() end |
#get_ingestion_destination(params = {}) ⇒ Types::GetIngestionDestinationResponse
Returns information about an ingestion destination.
1209 1210 1211 1212 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1209 def get_ingestion_destination(params = {}, = {}) req = build_request(:get_ingestion_destination, params) req.send_request() 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.
1266 1267 1268 1269 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1266 def (params = {}, = {}) req = build_request(:list_app_authorizations, params) req.send_request() 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.
1312 1313 1314 1315 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1312 def list_app_bundles(params = {}, = {}) req = build_request(:list_app_bundles, params) req.send_request() 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.
1369 1370 1371 1372 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1369 def list_ingestion_destinations(params = {}, = {}) req = build_request(:list_ingestion_destinations, params) req.send_request() 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.
1423 1424 1425 1426 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1423 def list_ingestions(params = {}, = {}) req = build_request(:list_ingestions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags for a resource.
1454 1455 1456 1457 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1454 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_ingestion(params = {}) ⇒ Struct
Starts (enables) an ingestion, which collects data from an application.
1483 1484 1485 1486 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1483 def start_ingestion(params = {}, = {}) req = build_request(:start_ingestion, params) req.send_request() 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.
1525 1526 1527 1528 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1525 def start_user_access_tasks(params = {}, = {}) req = build_request(:start_user_access_tasks, params) req.send_request() end |
#stop_ingestion(params = {}) ⇒ Struct
Stops (disables) an ingestion.
1553 1554 1555 1556 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1553 def stop_ingestion(params = {}, = {}) req = build_request(:stop_ingestion, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified resource.
1585 1586 1587 1588 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1585 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag or tags from a resource.
1612 1613 1614 1615 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1612 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() 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.
1686 1687 1688 1689 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1686 def (params = {}, = {}) req = build_request(:update_app_authorization, params) req.send_request() 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.
1753 1754 1755 1756 |
# File 'gems/aws-sdk-appfabric/lib/aws-sdk-appfabric/client.rb', line 1753 def update_ingestion_destination(params = {}, = {}) req = build_request(:update_ingestion_destination, params) req.send_request() end |