Struct aws_sdk_ssmsap::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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_ssmsap::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_ssmsap::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_ssmsap::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn delete_resource_permission(&self) -> DeleteResourcePermission

Constructs a fluent builder for the DeleteResourcePermission operation.

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

    Delete or restore the permissions on the target database.

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

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

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

    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>

pub fn deregister_application(&self) -> DeregisterApplication

Constructs a fluent builder for the DeregisterApplication operation.

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

    The ID of the application.

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

pub fn get_application(&self) -> GetApplication

Constructs a fluent builder for the GetApplication operation.

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

    The ID of the application.

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

    The Amazon Resource Name (ARN) of the application.

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

    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>

pub fn get_component(&self) -> GetComponent

Constructs a fluent builder for the GetComponent operation.

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

    The ID of the application.

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

    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.

• On failure, responds with SdkError<GetComponentError>

pub fn get_database(&self) -> GetDatabase

Constructs a fluent builder for the GetDatabase operation.

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

    The ID of the application.

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

    The ID of the component.

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

    The ID of the database.

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

    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>

pub fn get_operation(&self) -> GetOperation

Constructs a fluent builder for the GetOperation operation.

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

    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>

pub fn get_resource_permission(&self) -> GetResourcePermission

Constructs a fluent builder for the GetResourcePermission operation.

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

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

    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>

pub fn list_applications(&self) -> ListApplications

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>):

    The token for the next page of results.

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

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

• 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>

pub fn list_components(&self) -> ListComponents

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>):

    The ID of the application.

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

    The token for the next page of results.

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

    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>

pub fn list_databases(&self) -> ListDatabases

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>):

    The ID of the application.

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

    The ID of the component.

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

    The token for the next page of results.

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

    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>

pub fn list_operations(&self) -> ListOperations

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>):

    The ID of the application.

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

    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>):

    The token for the next page of results.

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

    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>

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

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

    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>

pub fn put_resource_permission(&self) -> PutResourcePermission

Constructs a fluent builder for the PutResourcePermission operation.

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

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

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

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

• On failure, responds with SdkError<PutResourcePermissionError>

pub fn register_application(&self) -> RegisterApplication

Constructs a fluent builder for the RegisterApplication operation.

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

    The ID of the application.

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

    The type of the application.

  • instances(Vec<String>) / set_instances(Option<Vec<String>>):

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

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

    The SAP instance number of the application.

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

    The System ID of the application.

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

    The tags to be attached to the SAP application.

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

    The credentials of the SAP application.

• 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>

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

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

    The Amazon Resource Name (ARN) of the resource.

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

    The tags on a resource.

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

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

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

    The Amazon Resource Name (ARN) of the resource.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    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>

pub fn update_application_settings(&self) -> UpdateApplicationSettings

Constructs a fluent builder for the UpdateApplicationSettings operation.

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

    The ID of the application.

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

    The credentials to be added or updated.

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

    The credentials to be removed.

• 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 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.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf 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 conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy 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.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.