Struct Client

pub struct Client { /* private fields */ }

Client for AWS Systems Manager for SAP

Client for invoking operations on AWS Systems Manager for SAP. Each operation on AWS Systems Manager for SAP is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_ssmsap::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_ssmsap::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the DeleteResourcePermission operation has a Client::delete_resource_permission, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.delete_resource_permission()
    .action_type("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn delete_resource_permission( &self, ) -> DeleteResourcePermissionFluentBuilder

Constructs a fluent builder for the DeleteResourcePermission operation.

• The fluent builder is configurable:
  • action_type(PermissionActionType) / set_action_type(Option<PermissionActionType>):
    required: false
    

    Delete or restore the permissions on the target database.

    
    
  • source_resource_arn(impl Into<String>) / set_source_resource_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the source resource.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
• On success, responds with DeleteResourcePermissionOutput with field(s):
  • policy(Option<String>):

    The policy that removes permissions on the target database.

• On failure, responds with SdkError<DeleteResourcePermissionError>

impl Client

pub fn deregister_application(&self) -> DeregisterApplicationFluentBuilder

Constructs a fluent builder for the DeregisterApplication operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The ID of the application.

    
    
• On success, responds with DeregisterApplicationOutput
• On failure, responds with SdkError<DeregisterApplicationError>

impl Client

pub fn get_application(&self) -> GetApplicationFluentBuilder

Constructs a fluent builder for the GetApplication operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: false
    

    The ID of the application.

    
    
  • application_arn(impl Into<String>) / set_application_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the application.

    
    
  • app_registry_arn(impl Into<String>) / set_app_registry_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the application registry.

    
    
• On success, responds with GetApplicationOutput with field(s):
  • application(Option<Application>):

    Returns all of the metadata of an application registered with AWS Systems Manager for SAP.

  • tags(Option<HashMap::<String, String>>):

    The tags of a registered application.

• On failure, responds with SdkError<GetApplicationError>

impl Client

pub fn get_component(&self) -> GetComponentFluentBuilder

Constructs a fluent builder for the GetComponent operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The ID of the application.

    
    
  • component_id(impl Into<String>) / set_component_id(Option<String>):
    required: true
    

    The ID of the component.

    
    
• On success, responds with GetComponentOutput with field(s):
  • component(Option<Component>):

    The component of an application registered with AWS Systems Manager for SAP.

  • tags(Option<HashMap::<String, String>>):

    The tags of a component.

• On failure, responds with SdkError<GetComponentError>

impl Client

pub fn get_database(&self) -> GetDatabaseFluentBuilder

Constructs a fluent builder for the GetDatabase operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: false
    

    The ID of the application.

    
    
  • component_id(impl Into<String>) / set_component_id(Option<String>):
    required: false
    

    The ID of the component.

    
    
  • database_id(impl Into<String>) / set_database_id(Option<String>):
    required: false
    

    The ID of the database.

    
    
  • database_arn(impl Into<String>) / set_database_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the database.

    
    
• On success, responds with GetDatabaseOutput with field(s):
  • database(Option<Database>):

    The SAP HANA database of an application registered with AWS Systems Manager for SAP.

  • tags(Option<HashMap::<String, String>>):

    The tags of a database.

• On failure, responds with SdkError<GetDatabaseError>

impl Client

pub fn get_operation(&self) -> GetOperationFluentBuilder

Constructs a fluent builder for the GetOperation operation.

• The fluent builder is configurable:
  • operation_id(impl Into<String>) / set_operation_id(Option<String>):
    required: true
    

    The ID of the operation.

    
    
• On success, responds with GetOperationOutput with field(s):
  • operation(Option<Operation>):

    Returns the details of an operation.

• On failure, responds with SdkError<GetOperationError>

impl Client

pub fn get_resource_permission(&self) -> GetResourcePermissionFluentBuilder

Constructs a fluent builder for the GetResourcePermission operation.

• The fluent builder is configurable:
  • action_type(PermissionActionType) / set_action_type(Option<PermissionActionType>):
    required: false
    
    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
• On success, responds with GetResourcePermissionOutput with field(s):
  • policy(Option<String>):

• On failure, responds with SdkError<GetResourcePermissionError>

impl Client

pub fn list_applications(&self) -> ListApplicationsFluentBuilder

Constructs a fluent builder for the ListApplications operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    The filter of name, value, and operator.

    
    
• On success, responds with ListApplicationsOutput with field(s):
  • applications(Option<Vec::<ApplicationSummary>>):

    The applications registered with AWS Systems Manager for SAP.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListApplicationsError>

impl Client

pub fn list_components(&self) -> ListComponentsFluentBuilder

Constructs a fluent builder for the ListComponents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: false
    

    The ID of the application.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If you do not specify a value for MaxResults, the request returns 50 items per page by default.

    
    
• On success, responds with ListComponentsOutput with field(s):
  • components(Option<Vec::<ComponentSummary>>):

    List of components registered with AWS System Manager for SAP.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListComponentsError>

impl Client

pub fn list_databases(&self) -> ListDatabasesFluentBuilder

Constructs a fluent builder for the ListDatabases operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: false
    

    The ID of the application.

    
    
  • component_id(impl Into<String>) / set_component_id(Option<String>):
    required: false
    

    The ID of the component.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.

    
    
• On success, responds with ListDatabasesOutput with field(s):
  • databases(Option<Vec::<DatabaseSummary>>):

    The SAP HANA databases of an application.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListDatabasesError>

impl Client

pub fn list_operation_events(&self) -> ListOperationEventsFluentBuilder

Constructs a fluent builder for the ListOperationEvents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • operation_id(impl Into<String>) / set_operation_id(Option<String>):
    required: true
    

    The ID of the operation.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If you do not specify a value for MaxResults, the request returns 50 items per page by default.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    Optionally specify filters to narrow the returned operation event items.

    Valid filter names include status, resourceID, and resourceType. The valid operator for all three filters is Equals.

    
    
• On success, responds with ListOperationEventsOutput with field(s):
  • operation_events(Option<Vec::<OperationEvent>>):

    A returned list of operation events that meet the filter criteria.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListOperationEventsError>

impl Client

pub fn list_operations(&self) -> ListOperationsFluentBuilder

Constructs a fluent builder for the ListOperations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The ID of the application.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next page of results.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    The filters of an operation.

    
    
• On success, responds with ListOperationsOutput with field(s):
  • operations(Option<Vec::<Operation>>):

    List of operations performed by AWS Systems Manager for SAP.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListOperationsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_resource_permission(&self) -> PutResourcePermissionFluentBuilder

Constructs a fluent builder for the PutResourcePermission operation.

• The fluent builder is configurable:
  • action_type(PermissionActionType) / set_action_type(Option<PermissionActionType>):
    required: true
    
    
    
  • source_resource_arn(impl Into<String>) / set_source_resource_arn(Option<String>):
    required: true
    
    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    
    
    
• On success, responds with PutResourcePermissionOutput with field(s):
  • policy(Option<String>):

• On failure, responds with SdkError<PutResourcePermissionError>

impl Client

pub fn register_application(&self) -> RegisterApplicationFluentBuilder

Constructs a fluent builder for the RegisterApplication operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The ID of the application.

    
    
  • application_type(ApplicationType) / set_application_type(Option<ApplicationType>):
    required: true
    

    The type of the application.

    
    
  • instances(impl Into<String>) / set_instances(Option<Vec::<String>>):
    required: true
    

    The Amazon EC2 instances on which your SAP application is running.

    
    
  • sap_instance_number(impl Into<String>) / set_sap_instance_number(Option<String>):
    required: false
    

    The SAP instance number of the application.

    
    
  • sid(impl Into<String>) / set_sid(Option<String>):
    required: false
    

    The System ID of the application.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to be attached to the SAP application.

    
    
  • credentials(ApplicationCredential) / set_credentials(Option<Vec::<ApplicationCredential>>):
    required: false
    

    The credentials of the SAP application.

    
    
  • database_arn(impl Into<String>) / set_database_arn(Option<String>):
    required: false
    

    The Amazon Resource Name of the SAP HANA database.

    
    
  • components_info(ComponentInfo) / set_components_info(Option<Vec::<ComponentInfo>>):
    required: false
    

    This is an optional parameter for component details to which the SAP ABAP application is attached, such as Web Dispatcher.

    This is an array of ApplicationComponent objects. You may input 0 to 5 items.

    
    
• On success, responds with RegisterApplicationOutput with field(s):
  • application(Option<Application>):

    The application registered with AWS Systems Manager for SAP.

  • operation_id(Option<String>):

    The ID of the operation.

• On failure, responds with SdkError<RegisterApplicationError>

impl Client

pub fn start_application(&self) -> StartApplicationFluentBuilder

Constructs a fluent builder for the StartApplication operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The ID of the application.

    
    
• On success, responds with StartApplicationOutput with field(s):
  • operation_id(Option<String>):

    The ID of the operation.

• On failure, responds with SdkError<StartApplicationError>

impl Client

pub fn start_application_refresh(&self) -> StartApplicationRefreshFluentBuilder

Constructs a fluent builder for the StartApplicationRefresh operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The ID of the application.

    
    
• On success, responds with StartApplicationRefreshOutput with field(s):
  • operation_id(Option<String>):

    The ID of the operation.

• On failure, responds with SdkError<StartApplicationRefreshError>

impl Client

pub fn stop_application(&self) -> StopApplicationFluentBuilder

Constructs a fluent builder for the StopApplication operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The ID of the application.

    
    
  • stop_connected_entity(ConnectedEntityType) / set_stop_connected_entity(Option<ConnectedEntityType>):
    required: false
    

    Specify the ConnectedEntityType. Accepted type is DBMS.

    If this parameter is included, the connected DBMS (Database Management System) will be stopped.

    
    
  • include_ec2_instance_shutdown(bool) / set_include_ec2_instance_shutdown(Option<bool>):
    required: false
    

    Boolean. If included and if set to True, the StopApplication operation will shut down the associated Amazon EC2 instance in addition to the application.

    
    
• On success, responds with StopApplicationOutput with field(s):
  • operation_id(Option<String>):

    The ID of the operation.

• On failure, responds with SdkError<StopApplicationError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags on a resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    Adds/updates or removes credentials for applications registered with AWS Systems Manager for SAP.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_application_settings( &self, ) -> UpdateApplicationSettingsFluentBuilder

Constructs a fluent builder for the UpdateApplicationSettings operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The ID of the application.

    
    
  • credentials_to_add_or_update(ApplicationCredential) / set_credentials_to_add_or_update(Option<Vec::<ApplicationCredential>>):
    required: false
    

    The credentials to be added or updated.

    
    
  • credentials_to_remove(ApplicationCredential) / set_credentials_to_remove(Option<Vec::<ApplicationCredential>>):
    required: false
    

    The credentials to be removed.

    
    
  • backint(BackintConfig) / set_backint(Option<BackintConfig>):
    required: false
    

    Installation of AWS Backint Agent for SAP HANA.

    
    
  • database_arn(impl Into<String>) / set_database_arn(Option<String>):
    required: false
    

    The Amazon Resource Name of the SAP HANA database that replaces the current SAP HANA connection with the SAP_ABAP application.

    
    
• On success, responds with UpdateApplicationSettingsOutput with field(s):
  • message(Option<String>):

    The update message.

  • operation_ids(Option<Vec::<String>>):

    The IDs of the operations.

• On failure, responds with SdkError<UpdateApplicationSettingsError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.