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_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_refresh(params = {}) ⇒ Types::StartApplicationRefreshOutput
Refreshes a registered 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.
409 410 411 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 409 def initialize(*args) super end |
Instance Method Details
#delete_resource_permission(params = {}) ⇒ Types::DeleteResourcePermissionOutput
Removes permissions associated with the target database.
446 447 448 449 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 446 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.
470 471 472 473 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 470 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.
519 520 521 522 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 519 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.
594 595 596 597 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 594 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.
651 652 653 654 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 651 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.
690 691 692 693 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 690 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.
721 722 723 724 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 721 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.
776 777 778 779 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 776 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.
827 828 829 830 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 827 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.
882 883 884 885 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 882 def list_databases(params = {}, = {}) req = build_request(:list_databases, 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.
947 948 949 950 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 947 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.
977 978 979 980 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 977 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.
1010 1011 1012 1013 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1010 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.
1095 1096 1097 1098 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1095 def register_application(params = {}, = {}) req = build_request(:register_application, params) req.send_request() end |
#start_application_refresh(params = {}) ⇒ Types::StartApplicationRefreshOutput
Refreshes a registered application.
1123 1124 1125 1126 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1123 def start_application_refresh(params = {}, = {}) req = build_request(:start_application_refresh, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Creates tag for a resource by specifying the ARN.
1151 1152 1153 1154 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1151 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Delete the tags for a resource.
1178 1179 1180 1181 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1178 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.
1242 1243 1244 1245 |
# File 'gems/aws-sdk-ssmsap/lib/aws-sdk-ssmsap/client.rb', line 1242 def update_application_settings(params = {}, = {}) req = build_request(:update_application_settings, params) req.send_request() end |