Class: Aws::SsmSap::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SsmSap::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb
Overview
An API client for SsmSap. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::SsmSap::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
-
#delete_resource_permission(params = {}) ⇒ Types::DeleteResourcePermissionOutput
Removes permissions associated with the target database.
-
#deregister_application(params = {}) ⇒ Struct
Deregister an SAP application with AWS Systems Manager for SAP.
-
#get_application(params = {}) ⇒ Types::GetApplicationOutput
Gets an application registered with AWS Systems Manager for SAP.
-
#get_component(params = {}) ⇒ Types::GetComponentOutput
Gets the component of an application registered with AWS Systems Manager for SAP.
-
#get_database(params = {}) ⇒ Types::GetDatabaseOutput
Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
-
#get_operation(params = {}) ⇒ Types::GetOperationOutput
Gets the details of an operation by specifying the operation ID.
-
#get_resource_permission(params = {}) ⇒ Types::GetResourcePermissionOutput
Gets permissions associated with the target database.
-
#list_applications(params = {}) ⇒ Types::ListApplicationsOutput
Lists all the applications registered with AWS Systems Manager for SAP.
-
#list_components(params = {}) ⇒ Types::ListComponentsOutput
Lists all the components registered with AWS Systems Manager for SAP.
-
#list_databases(params = {}) ⇒ Types::ListDatabasesOutput
Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
-
#list_operation_events(params = {}) ⇒ Types::ListOperationEventsOutput
Returns a list of operations events.
-
#list_operations(params = {}) ⇒ Types::ListOperationsOutput
Lists the operations performed by AWS Systems Manager for SAP.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
-
#put_resource_permission(params = {}) ⇒ Types::PutResourcePermissionOutput
Adds permissions to the target database.
-
#register_application(params = {}) ⇒ Types::RegisterApplicationOutput
Register an SAP application with AWS Systems Manager for SAP.
-
#start_application(params = {}) ⇒ Types::StartApplicationOutput
Request is an operation which starts an application.
-
#start_application_refresh(params = {}) ⇒ Types::StartApplicationRefreshOutput
Refreshes a registered application.
-
#stop_application(params = {}) ⇒ Types::StopApplicationOutput
Request is an operation to stop an application.
-
#tag_resource(params = {}) ⇒ Struct
Creates tag for a resource by specifying the ARN.
-
#untag_resource(params = {}) ⇒ Struct
Delete the tags for a resource.
-
#update_application_settings(params = {}) ⇒ Types::UpdateApplicationSettingsOutput
Updates the settings of an application registered with AWS Systems Manager for SAP.
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.
446 447 448 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 446 def initialize(*args) super end |
Instance Method Details
#delete_resource_permission(params = {}) ⇒ Types::DeleteResourcePermissionOutput
Removes permissions associated with the target database.
483 484 485 486 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 483 def (params = {}, = {}) req = build_request(:delete_resource_permission, params) req.send_request() end |
#deregister_application(params = {}) ⇒ Struct
Deregister an SAP application with AWS Systems Manager for SAP. This action does not affect the existing setup of your SAP workloads on Amazon EC2.
507 508 509 510 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 507 def deregister_application(params = {}, = {}) req = build_request(:deregister_application, params) req.send_request() end |
#get_application(params = {}) ⇒ Types::GetApplicationOutput
Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.
558 559 560 561 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 558 def get_application(params = {}, = {}) req = build_request(:get_application, params) req.send_request() end |
#get_component(params = {}) ⇒ Types::GetComponentOutput
Gets the component of an application registered with AWS Systems Manager for SAP.
633 634 635 636 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 633 def get_component(params = {}, = {}) req = build_request(:get_component, params) req.send_request() end |
#get_database(params = {}) ⇒ Types::GetDatabaseOutput
Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
692 693 694 695 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 692 def get_database(params = {}, = {}) req = build_request(:get_database, params) req.send_request() end |
#get_operation(params = {}) ⇒ Types::GetOperationOutput
Gets the details of an operation by specifying the operation ID.
731 732 733 734 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 731 def get_operation(params = {}, = {}) req = build_request(:get_operation, params) req.send_request() end |
#get_resource_permission(params = {}) ⇒ Types::GetResourcePermissionOutput
Gets permissions associated with the target database.
762 763 764 765 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 762 def (params = {}, = {}) req = build_request(:get_resource_permission, params) req.send_request() end |
#list_applications(params = {}) ⇒ Types::ListApplicationsOutput
Lists all the applications registered with AWS Systems Manager for SAP.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
817 818 819 820 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 817 def list_applications(params = {}, = {}) req = build_request(:list_applications, params) req.send_request() end |
#list_components(params = {}) ⇒ Types::ListComponentsOutput
Lists all the components registered with AWS Systems Manager for SAP.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
868 869 870 871 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 868 def list_components(params = {}, = {}) req = build_request(:list_components, params) req.send_request() end |
#list_databases(params = {}) ⇒ Types::ListDatabasesOutput
Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
923 924 925 926 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 923 def list_databases(params = {}, = {}) req = build_request(:list_databases, params) req.send_request() end |
#list_operation_events(params = {}) ⇒ Types::ListOperationEventsOutput
Returns a list of operations events.
Available parameters include OperationID
, as well as optional
parameters MaxResults
, NextToken
, and Filters
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
992 993 994 995 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 992 def list_operation_events(params = {}, = {}) req = build_request(:list_operation_events, params) req.send_request() end |
#list_operations(params = {}) ⇒ Types::ListOperationsOutput
Lists the operations performed by AWS Systems Manager for SAP.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1057 1058 1059 1060 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1057 def list_operations(params = {}, = {}) req = build_request(:list_operations, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
1087 1088 1089 1090 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1087 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_resource_permission(params = {}) ⇒ Types::PutResourcePermissionOutput
Adds permissions to the target database.
1120 1121 1122 1123 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1120 def (params = {}, = {}) req = build_request(:put_resource_permission, params) req.send_request() end |
#register_application(params = {}) ⇒ Types::RegisterApplicationOutput
Register an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering.
The SAP application you want to register with AWS Systems Manager for SAP is running on Amazon EC2.
AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required IAM permissions.
Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to manage SAP applications and components.
1207 1208 1209 1210 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1207 def register_application(params = {}, = {}) req = build_request(:register_application, params) req.send_request() end |
#start_application(params = {}) ⇒ Types::StartApplicationOutput
Request is an operation which starts an application.
Parameter ApplicationId
is required.
1237 1238 1239 1240 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1237 def start_application(params = {}, = {}) req = build_request(:start_application, params) req.send_request() end |
#start_application_refresh(params = {}) ⇒ Types::StartApplicationRefreshOutput
Refreshes a registered application.
1265 1266 1267 1268 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1265 def start_application_refresh(params = {}, = {}) req = build_request(:start_application_refresh, params) req.send_request() end |
#stop_application(params = {}) ⇒ Types::StopApplicationOutput
Request is an operation to stop an application.
Parameter ApplicationId
is required. Parameters
StopConnectedEntity
and IncludeEc2InstanceShutdown
are optional.
1309 1310 1311 1312 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1309 def stop_application(params = {}, = {}) req = build_request(:stop_application, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Creates tag for a resource by specifying the ARN.
1337 1338 1339 1340 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1337 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Delete the tags for a resource.
1364 1365 1366 1367 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1364 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application_settings(params = {}) ⇒ Types::UpdateApplicationSettingsOutput
Updates the settings of an application registered with AWS Systems Manager for SAP.
1428 1429 1430 1431 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1428 def update_application_settings(params = {}, = {}) req = build_request(:update_application_settings, params) req.send_request() end |