/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the ssm-sap-2018-05-10.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.SsmSap.Model;
namespace Amazon.SsmSap
{
///
/// Interface for accessing SsmSap
///
/// This API reference provides descriptions, syntax, and other details about each of
/// the actions and data types for AWS Systems Manager for SAP. The topic for each action
/// shows the API request parameters and responses.
///
public partial interface IAmazonSsmSap : IAmazonService, IDisposable
{
///
/// Paginators for the service
///
ISsmSapPaginatorFactory Paginators { get; }
#region DeleteResourcePermission
///
/// Removes permissions associated with the target database.
///
/// Container for the necessary parameters to execute the DeleteResourcePermission service method.
///
/// The response from the DeleteResourcePermission service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for DeleteResourcePermission Operation
DeleteResourcePermissionResponse DeleteResourcePermission(DeleteResourcePermissionRequest request);
///
/// Removes permissions associated with the target database.
///
/// Container for the necessary parameters to execute the DeleteResourcePermission service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteResourcePermission service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for DeleteResourcePermission Operation
Task DeleteResourcePermissionAsync(DeleteResourcePermissionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeregisterApplication
///
/// 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.
///
/// Container for the necessary parameters to execute the DeregisterApplication service method.
///
/// The response from the DeregisterApplication service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for DeregisterApplication Operation
DeregisterApplicationResponse DeregisterApplication(DeregisterApplicationRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the DeregisterApplication service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeregisterApplication service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for DeregisterApplication Operation
Task DeregisterApplicationAsync(DeregisterApplicationRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetApplication
///
/// Gets an application registered with AWS Systems Manager for SAP. It also returns the
/// components of the application.
///
/// Container for the necessary parameters to execute the GetApplication service method.
///
/// The response from the GetApplication service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetApplication Operation
GetApplicationResponse GetApplication(GetApplicationRequest request);
///
/// Gets an application registered with AWS Systems Manager for SAP. It also returns the
/// components of the application.
///
/// Container for the necessary parameters to execute the GetApplication service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetApplication service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetApplication Operation
Task GetApplicationAsync(GetApplicationRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetComponent
///
/// Gets the component of an application registered with AWS Systems Manager for SAP.
///
/// Container for the necessary parameters to execute the GetComponent service method.
///
/// The response from the GetComponent service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetComponent Operation
GetComponentResponse GetComponent(GetComponentRequest request);
///
/// Gets the component of an application registered with AWS Systems Manager for SAP.
///
/// Container for the necessary parameters to execute the GetComponent service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetComponent service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetComponent Operation
Task GetComponentAsync(GetComponentRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetDatabase
///
/// Gets the SAP HANA database of an application registered with AWS Systems Manager for
/// SAP.
///
/// Container for the necessary parameters to execute the GetDatabase service method.
///
/// The response from the GetDatabase service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetDatabase Operation
GetDatabaseResponse GetDatabase(GetDatabaseRequest request);
///
/// Gets the SAP HANA database of an application registered with AWS Systems Manager for
/// SAP.
///
/// Container for the necessary parameters to execute the GetDatabase service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetDatabase service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetDatabase Operation
Task GetDatabaseAsync(GetDatabaseRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetOperation
///
/// Gets the details of an operation by specifying the operation ID.
///
/// Container for the necessary parameters to execute the GetOperation service method.
///
/// The response from the GetOperation service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetOperation Operation
GetOperationResponse GetOperation(GetOperationRequest request);
///
/// Gets the details of an operation by specifying the operation ID.
///
/// Container for the necessary parameters to execute the GetOperation service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetOperation service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetOperation Operation
Task GetOperationAsync(GetOperationRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetResourcePermission
///
/// Gets permissions associated with the target database.
///
/// Container for the necessary parameters to execute the GetResourcePermission service method.
///
/// The response from the GetResourcePermission service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetResourcePermission Operation
GetResourcePermissionResponse GetResourcePermission(GetResourcePermissionRequest request);
///
/// Gets permissions associated with the target database.
///
/// Container for the necessary parameters to execute the GetResourcePermission service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetResourcePermission service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetResourcePermission Operation
Task GetResourcePermissionAsync(GetResourcePermissionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListApplications
///
/// Lists all the applications registered with AWS Systems Manager for SAP.
///
/// Container for the necessary parameters to execute the ListApplications service method.
///
/// The response from the ListApplications service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListApplications Operation
ListApplicationsResponse ListApplications(ListApplicationsRequest request);
///
/// Lists all the applications registered with AWS Systems Manager for SAP.
///
/// Container for the necessary parameters to execute the ListApplications service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListApplications service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListApplications Operation
Task ListApplicationsAsync(ListApplicationsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListComponents
///
/// Lists all the components registered with AWS Systems Manager for SAP.
///
/// Container for the necessary parameters to execute the ListComponents service method.
///
/// The response from the ListComponents service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListComponents Operation
ListComponentsResponse ListComponents(ListComponentsRequest request);
///
/// Lists all the components registered with AWS Systems Manager for SAP.
///
/// Container for the necessary parameters to execute the ListComponents service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListComponents service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListComponents Operation
Task ListComponentsAsync(ListComponentsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListDatabases
///
/// Lists the SAP HANA databases of an application registered with AWS Systems Manager
/// for SAP.
///
/// Container for the necessary parameters to execute the ListDatabases service method.
///
/// The response from the ListDatabases service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListDatabases Operation
ListDatabasesResponse ListDatabases(ListDatabasesRequest request);
///
/// Lists the SAP HANA databases of an application registered with AWS Systems Manager
/// for SAP.
///
/// Container for the necessary parameters to execute the ListDatabases service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListDatabases service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListDatabases Operation
Task ListDatabasesAsync(ListDatabasesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListOperations
///
/// Lists the operations performed by AWS Systems Manager for SAP.
///
/// Container for the necessary parameters to execute the ListOperations service method.
///
/// The response from the ListOperations service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListOperations Operation
ListOperationsResponse ListOperations(ListOperationsRequest request);
///
/// Lists the operations performed by AWS Systems Manager for SAP.
///
/// Container for the necessary parameters to execute the ListOperations service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListOperations service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListOperations Operation
Task ListOperationsAsync(ListOperationsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// Lists all tags on an SAP HANA application and/or database registered with AWS Systems
/// Manager for SAP.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by SsmSap.
///
/// A conflict has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request);
///
/// Lists all tags on an SAP HANA application and/or database registered with AWS Systems
/// Manager for SAP.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by SsmSap.
///
/// A conflict has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region PutResourcePermission
///
/// Adds permissions to the target database.
///
/// Container for the necessary parameters to execute the PutResourcePermission service method.
///
/// The response from the PutResourcePermission service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for PutResourcePermission Operation
PutResourcePermissionResponse PutResourcePermission(PutResourcePermissionRequest request);
///
/// Adds permissions to the target database.
///
/// Container for the necessary parameters to execute the PutResourcePermission service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutResourcePermission service method, as returned by SsmSap.
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for PutResourcePermission Operation
Task PutResourcePermissionAsync(PutResourcePermissionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RegisterApplication
///
/// 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.
///
///
/// Container for the necessary parameters to execute the RegisterApplication service method.
///
/// The response from the RegisterApplication service method, as returned by SsmSap.
///
/// A conflict has occurred.
///
///
/// An internal error has occurred.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for RegisterApplication Operation
RegisterApplicationResponse RegisterApplication(RegisterApplicationRequest request);
///
/// 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.
///
///
/// Container for the necessary parameters to execute the RegisterApplication service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RegisterApplication service method, as returned by SsmSap.
///
/// A conflict has occurred.
///
///
/// An internal error has occurred.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for RegisterApplication Operation
Task RegisterApplicationAsync(RegisterApplicationRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartApplicationRefresh
///
/// Refreshes a registered application.
///
/// Container for the necessary parameters to execute the StartApplicationRefresh service method.
///
/// The response from the StartApplicationRefresh service method, as returned by SsmSap.
///
/// A conflict has occurred.
///
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for StartApplicationRefresh Operation
StartApplicationRefreshResponse StartApplicationRefresh(StartApplicationRefreshRequest request);
///
/// Refreshes a registered application.
///
/// Container for the necessary parameters to execute the StartApplicationRefresh service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartApplicationRefresh service method, as returned by SsmSap.
///
/// A conflict has occurred.
///
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for StartApplicationRefresh Operation
Task StartApplicationRefreshAsync(StartApplicationRefreshRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// Creates tag for a resource by specifying the ARN.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by SsmSap.
///
/// A conflict has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for TagResource Operation
TagResourceResponse TagResource(TagResourceRequest request);
///
/// Creates tag for a resource by specifying the ARN.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by SsmSap.
///
/// A conflict has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Delete the tags for a resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by SsmSap.
///
/// A conflict has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for UntagResource Operation
UntagResourceResponse UntagResource(UntagResourceRequest request);
///
/// Delete the tags for a resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by SsmSap.
///
/// A conflict has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateApplicationSettings
///
/// Updates the settings of an application registered with AWS Systems Manager for SAP.
///
/// Container for the necessary parameters to execute the UpdateApplicationSettings service method.
///
/// The response from the UpdateApplicationSettings service method, as returned by SsmSap.
///
/// A conflict has occurred.
///
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for UpdateApplicationSettings Operation
UpdateApplicationSettingsResponse UpdateApplicationSettings(UpdateApplicationSettingsRequest request);
///
/// Updates the settings of an application registered with AWS Systems Manager for SAP.
///
/// Container for the necessary parameters to execute the UpdateApplicationSettings service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateApplicationSettings service method, as returned by SsmSap.
///
/// A conflict has occurred.
///
///
/// An internal error has occurred.
///
///
/// The resource is not available.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for UpdateApplicationSettings Operation
Task UpdateApplicationSettingsAsync(UpdateApplicationSettingsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}