Struct aws_sdk_resiliencehub::client::Client

pub struct Client { /* private fields */ }

Client for AWS Resilience Hub

Client for invoking operations on AWS Resilience Hub. Each operation on AWS Resilience Hub 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_resiliencehub::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 Config 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_resiliencehub::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 AddDraftAppVersionResourceMappings operation has a Client::add_draft_app_version_resource_mappings, 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.add_draft_app_version_resource_mappings()
    .app_arn("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 add_draft_app_version_resource_mappings( &self ) -> AddDraftAppVersionResourceMappingsFluentBuilder

Constructs a fluent builder for the AddDraftAppVersionResourceMappings operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • resource_mappings(ResourceMapping) / set_resource_mappings(Option<Vec::<ResourceMapping>>):
    required: true
    

    Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.

    
    
• On success, responds with AddDraftAppVersionResourceMappingsOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    The version of the application.

  • resource_mappings(Vec::<ResourceMapping>):

    List of sources that are used to map a logical resource from the template to a physical resource. You can use sources such as CloudFormation, Terraform state files, AppRegistry applications, or Amazon EKS.

• On failure, responds with SdkError<AddDraftAppVersionResourceMappingsError>

impl Client

pub fn batch_update_recommendation_status( &self ) -> BatchUpdateRecommendationStatusFluentBuilder

Constructs a fluent builder for the BatchUpdateRecommendationStatus operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • request_entries(UpdateRecommendationStatusRequestEntry) / set_request_entries(Option<Vec::<UpdateRecommendationStatusRequestEntry>>):
    required: true
    

    Defines the list of operational recommendations that need to be included or excluded.

    
    
• On success, responds with BatchUpdateRecommendationStatusOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • successful_entries(Vec::<BatchUpdateRecommendationStatusSuccessfulEntry>):

    A list of items that were included or excluded.

  • failed_entries(Vec::<BatchUpdateRecommendationStatusFailedEntry>):

    A list of items with error details about each item, which could not be included or excluded.

• On failure, responds with SdkError<BatchUpdateRecommendationStatusError>

impl Client

pub fn create_app(&self) -> CreateAppFluentBuilder

Constructs a fluent builder for the CreateApp operation.

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

    Name of the application.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The optional description for an app.

    
    
  • policy_arn(impl Into<String>) / set_policy_arn(Option<String>):
    required: false
    

    Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

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

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    
    
  • assessment_schedule(AppAssessmentScheduleType) / set_assessment_schedule(Option<AppAssessmentScheduleType>):
    required: false
    

    Assessment execution schedule with ‘Daily’ or ‘Disabled’ values.

    
    
  • permission_model(PermissionModel) / set_permission_model(Option<PermissionModel>):
    required: false
    

    Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.

    
    
  • event_subscriptions(EventSubscription) / set_event_subscriptions(Option<Vec::<EventSubscription>>):
    required: false
    

    The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports only Drift detected and Scheduled assessment failure events notification.

    
    
• On success, responds with CreateAppOutput with field(s):
  • app(Option<App>):

    The created application returned as an object with details including compliance status, creation time, description, resiliency score, and more.

• On failure, responds with SdkError<CreateAppError>

impl Client

pub fn create_app_version_app_component( &self ) -> CreateAppVersionAppComponentFluentBuilder

Constructs a fluent builder for the CreateAppVersionAppComponent operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: false
    

    Identifier of the Application Component.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Name of the Application Component.

    
    
  • r#type(impl Into<String>) / set_type(Option<String>):
    required: true
    

    Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

    
    
  • additional_info(impl Into<String>, Vec::<String>) / set_additional_info(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    Currently, there is no supported additional information for Application Components.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    
    
• On success, responds with CreateAppVersionAppComponentOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    Resilience Hub application version.

  • app_component(Option<AppComponent>):

    List of Application Components that belong to this resource.

• On failure, responds with SdkError<CreateAppVersionAppComponentError>

impl Client

pub fn create_app_version_resource( &self ) -> CreateAppVersionResourceFluentBuilder

Constructs a fluent builder for the CreateAppVersionResource operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: false
    

    Name of the resource.

    
    
  • logical_resource_id(LogicalResourceId) / set_logical_resource_id(Option<LogicalResourceId>):
    required: true
    

    Logical identifier of the resource.

    
    
  • physical_resource_id(impl Into<String>) / set_physical_resource_id(Option<String>):
    required: true
    

    Physical identifier of the resource.

    
    
  • aws_region(impl Into<String>) / set_aws_region(Option<String>):
    required: false
    

    Amazon Web Services region that owns the physical resource.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: false
    

    Amazon Web Services account that owns the physical resource.

    
    
  • resource_type(impl Into<String>) / set_resource_type(Option<String>):
    required: true
    

    Type of resource.

    
    
  • app_components(impl Into<String>) / set_app_components(Option<Vec::<String>>):
    required: true
    

    List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

    
    
  • additional_info(impl Into<String>, Vec::<String>) / set_additional_info(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    Currently, there is no supported additional information for resources.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    
    
• On success, responds with CreateAppVersionResourceOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    Resilience Hub application version.

  • physical_resource(Option<PhysicalResource>):

    Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.

• On failure, responds with SdkError<CreateAppVersionResourceError>

impl Client

pub fn create_recommendation_template( &self ) -> CreateRecommendationTemplateFluentBuilder

Constructs a fluent builder for the CreateRecommendationTemplate operation.

• The fluent builder is configurable:
  • recommendation_ids(impl Into<String>) / set_recommendation_ids(Option<Vec::<String>>):
    required: false
    

    Identifiers for the recommendations used to create a recommendation template.

    
    
  • format(TemplateFormat) / set_format(Option<TemplateFormat>):
    required: false
    

    The format for the recommendation template.

    CfnJson

    The template is CloudFormation JSON.

    CfnYaml

    The template is CloudFormation YAML.

    
    
  • recommendation_types(RenderRecommendationType) / set_recommendation_types(Option<Vec::<RenderRecommendationType>>):
    required: false
    

    An array of strings that specify the recommendation template type or types.

    Alarm

    The template is an AlarmRecommendation template.

    Sop

    The template is a SopRecommendation template.

    Test

    The template is a TestRecommendation template.

    
    
  • assessment_arn(impl Into<String>) / set_assessment_arn(Option<String>):
    required: true
    

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name for the recommendation template.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

    
    
  • bucket_name(impl Into<String>) / set_bucket_name(Option<String>):
    required: false
    

    The name of the Amazon S3 bucket that will contain the recommendation template.

    
    
• On success, responds with CreateRecommendationTemplateOutput with field(s):
  • recommendation_template(Option<RecommendationTemplate>):

    The newly created recommendation template, returned as an object. This object includes the template’s name, format, status, tags, Amazon S3 bucket location, and more.

• On failure, responds with SdkError<CreateRecommendationTemplateError>

impl Client

pub fn create_resiliency_policy(&self) -> CreateResiliencyPolicyFluentBuilder

Constructs a fluent builder for the CreateResiliencyPolicy operation.

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

    The name of the policy

    
    
  • policy_description(impl Into<String>) / set_policy_description(Option<String>):
    required: false
    

    The description for the policy.

    
    
  • data_location_constraint(DataLocationConstraint) / set_data_location_constraint(Option<DataLocationConstraint>):
    required: false
    

    Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

    
    
  • tier(ResiliencyPolicyTier) / set_tier(Option<ResiliencyPolicyTier>):
    required: true
    

    The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

    
    
  • policy(DisruptionType, FailurePolicy) / set_policy(Option<HashMap::<DisruptionType, FailurePolicy>>):
    required: true
    

    The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

    
    
• On success, responds with CreateResiliencyPolicyOutput with field(s):
  • policy(Option<ResiliencyPolicy>):

    The type of resiliency policy that was created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

• On failure, responds with SdkError<CreateResiliencyPolicyError>

impl Client

pub fn delete_app(&self) -> DeleteAppFluentBuilder

Constructs a fluent builder for the DeleteApp operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • force_delete(bool) / set_force_delete(Option<bool>):
    required: false
    

    A boolean option to force the deletion of an Resilience Hub application.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    
    
• On success, responds with DeleteAppOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

• On failure, responds with SdkError<DeleteAppError>

impl Client

pub fn delete_app_assessment(&self) -> DeleteAppAssessmentFluentBuilder

Constructs a fluent builder for the DeleteAppAssessment operation.

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

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    
    
• On success, responds with DeleteAppAssessmentOutput with field(s):
  • assessment_arn(String):

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • assessment_status(AssessmentStatus):

    The current status of the assessment for the resiliency policy.

• On failure, responds with SdkError<DeleteAppAssessmentError>

impl Client

pub fn delete_app_input_source(&self) -> DeleteAppInputSourceFluentBuilder

Constructs a fluent builder for the DeleteAppInputSource operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • source_arn(impl Into<String>) / set_source_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the imported resource you want to remove from the Resilience Hub application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • terraform_source(TerraformSource) / set_terraform_source(Option<TerraformSource>):
    required: false
    

    The imported Terraform s3 state file you want to remove from the Resilience Hub application.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    
    
  • eks_source_cluster_namespace(EksSourceClusterNamespace) / set_eks_source_cluster_namespace(Option<EksSourceClusterNamespace>):
    required: false
    

    The namespace on your Amazon Elastic Kubernetes Service cluster that you want to delete from the Resilience Hub application.

    
    
• On success, responds with DeleteAppInputSourceOutput with field(s):
  • app_arn(Option<String>):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_input_source(Option<AppInputSource>):

    Name of the input source from where the application resource is imported from.

• On failure, responds with SdkError<DeleteAppInputSourceError>

impl Client

pub fn delete_app_version_app_component( &self ) -> DeleteAppVersionAppComponentFluentBuilder

Constructs a fluent builder for the DeleteAppVersionAppComponent operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    Identifier of the Application Component.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    
    
• On success, responds with DeleteAppVersionAppComponentOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    Resilience Hub application version.

  • app_component(Option<AppComponent>):

    List of Application Components that belong to this resource.

• On failure, responds with SdkError<DeleteAppVersionAppComponentError>

impl Client

pub fn delete_app_version_resource( &self ) -> DeleteAppVersionResourceFluentBuilder

Constructs a fluent builder for the DeleteAppVersionResource operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: false
    

    Name of the resource.

    
    
  • logical_resource_id(LogicalResourceId) / set_logical_resource_id(Option<LogicalResourceId>):
    required: false
    

    Logical identifier of the resource.

    
    
  • physical_resource_id(impl Into<String>) / set_physical_resource_id(Option<String>):
    required: false
    

    Physical identifier of the resource.

    
    
  • aws_region(impl Into<String>) / set_aws_region(Option<String>):
    required: false
    

    Amazon Web Services region that owns the physical resource.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: false
    

    Amazon Web Services account that owns the physical resource.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    
    
• On success, responds with DeleteAppVersionResourceOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    Resilience Hub application version.

  • physical_resource(Option<PhysicalResource>):

    Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.

• On failure, responds with SdkError<DeleteAppVersionResourceError>

impl Client

pub fn delete_recommendation_template( &self ) -> DeleteRecommendationTemplateFluentBuilder

Constructs a fluent builder for the DeleteRecommendationTemplate operation.

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

    The Amazon Resource Name (ARN) for a recommendation template.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    
    
• On success, responds with DeleteRecommendationTemplateOutput with field(s):
  • recommendation_template_arn(String):

    The Amazon Resource Name (ARN) for a recommendation template.

  • status(RecommendationTemplateStatus):

    Status of the action.

• On failure, responds with SdkError<DeleteRecommendationTemplateError>

impl Client

pub fn delete_resiliency_policy(&self) -> DeleteResiliencyPolicyFluentBuilder

Constructs a fluent builder for the DeleteResiliencyPolicy operation.

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

    Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

    
    
• On success, responds with DeleteResiliencyPolicyOutput with field(s):
  • policy_arn(String):

    Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

• On failure, responds with SdkError<DeleteResiliencyPolicyError>

impl Client

pub fn describe_app(&self) -> DescribeAppFluentBuilder

Constructs a fluent builder for the DescribeApp operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
• On success, responds with DescribeAppOutput with field(s):
  • app(Option<App>):

    The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.

• On failure, responds with SdkError<DescribeAppError>

impl Client

pub fn describe_app_assessment(&self) -> DescribeAppAssessmentFluentBuilder

Constructs a fluent builder for the DescribeAppAssessment operation.

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

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
• On success, responds with DescribeAppAssessmentOutput with field(s):
  • assessment(Option<AppAssessment>):

    The assessment for an Resilience Hub application, returned as an object. This object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, messages, resiliency scores, and more.

• On failure, responds with SdkError<DescribeAppAssessmentError>

impl Client

pub fn describe_app_version(&self) -> DescribeAppVersionFluentBuilder

Constructs a fluent builder for the DescribeAppVersion operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • app_version(impl Into<String>) / set_app_version(Option<String>):
    required: true
    

    Resilience Hub application version.

    
    
• On success, responds with DescribeAppVersionOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    Resilience Hub application version.

  • additional_info(Option<HashMap::<String, Vec::<String>>>):

    Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

    Currently, this parameter supports only failover region and account.

• On failure, responds with SdkError<DescribeAppVersionError>

impl Client

pub fn describe_app_version_app_component( &self ) -> DescribeAppVersionAppComponentFluentBuilder

Constructs a fluent builder for the DescribeAppVersionAppComponent operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • app_version(impl Into<String>) / set_app_version(Option<String>):
    required: true
    

    Resilience Hub application version.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    Identifier of the Application Component.

    
    
• On success, responds with DescribeAppVersionAppComponentOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    Resilience Hub application version.

  • app_component(Option<AppComponent>):

    List of Application Components that belong to this resource.

• On failure, responds with SdkError<DescribeAppVersionAppComponentError>

impl Client

pub fn describe_app_version_resource( &self ) -> DescribeAppVersionResourceFluentBuilder

Constructs a fluent builder for the DescribeAppVersionResource operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • app_version(impl Into<String>) / set_app_version(Option<String>):
    required: true
    

    Resilience Hub application version.

    
    
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: false
    

    Name of the resource.

    
    
  • logical_resource_id(LogicalResourceId) / set_logical_resource_id(Option<LogicalResourceId>):
    required: false
    

    Logical identifier of the resource.

    
    
  • physical_resource_id(impl Into<String>) / set_physical_resource_id(Option<String>):
    required: false
    

    Physical identifier of the resource.

    
    
  • aws_region(impl Into<String>) / set_aws_region(Option<String>):
    required: false
    

    Amazon Web Services region that owns the physical resource.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: false
    

    Amazon Web Services account that owns the physical resource.

    
    
• On success, responds with DescribeAppVersionResourceOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    Resilience Hub application version.

  • physical_resource(Option<PhysicalResource>):

    Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.

• On failure, responds with SdkError<DescribeAppVersionResourceError>

impl Client

pub fn describe_app_version_resources_resolution_status( &self ) -> DescribeAppVersionResourcesResolutionStatusFluentBuilder

Constructs a fluent builder for the DescribeAppVersionResourcesResolutionStatus operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • app_version(impl Into<String>) / set_app_version(Option<String>):
    required: true
    

    The version of the application.

    
    
  • resolution_id(impl Into<String>) / set_resolution_id(Option<String>):
    required: false
    

    The identifier for a specific resolution.

    
    
• On success, responds with DescribeAppVersionResourcesResolutionStatusOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    The version of the application.

  • resolution_id(String):

    The identifier for a specific resolution.

  • status(ResourceResolutionStatusType):

    Status of the action.

  • error_message(Option<String>):

    The returned error message for the request.

• On failure, responds with SdkError<DescribeAppVersionResourcesResolutionStatusError>

impl Client

pub fn describe_app_version_template( &self ) -> DescribeAppVersionTemplateFluentBuilder

Constructs a fluent builder for the DescribeAppVersionTemplate operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • app_version(impl Into<String>) / set_app_version(Option<String>):
    required: true
    

    The version of the application.

    
    
• On success, responds with DescribeAppVersionTemplateOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    The version of the application.

  • app_template_body(String):

    A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.

    The appTemplateBody JSON string has the following structure:

    • resources

      The list of logical resources that must be included in the Resilience Hub application.

      Type: Array

      Don’t add the resources that you want to exclude.

      Each resources array item includes the following fields:

      • logicalResourceId

        Logical identifier of the resource.

        Type: Object

        Each logicalResourceId object includes the following fields:

        • identifier

          Identifier of the resource.

          Type: String

        • logicalStackName

          The name of the CloudFormation stack this resource belongs to.

          Type: String

        • resourceGroupName

          The name of the resource group this resource belongs to.

          Type: String

        • terraformSourceName

          The name of the Terraform S3 state file this resource belongs to.

          Type: String

        • eksSourceName

          Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          This parameter accepts values in “eks-cluster/namespace” format.

          Type: String

      • type

        The type of resource.

        Type: string

      • name

        The name of the resource.

        Type: String

      • additionalInfo

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        Key: “failover-regions”

        Value: “[{“region”:“<REGION>”, “accounts”:[{“id”:“<ACCOUNT_ID>”}]}]“

    • appComponents

      List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

      Type: Array

      Each appComponents array item includes the following fields:

      • name

        Name of the Application Component.

        Type: String

      • type

        Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

        Type: String

      • resourceNames

        The list of included resources that are assigned to the Application Component.

        Type: Array of strings

      • additionalInfo

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        Key: “failover-regions”

        Value: “[{“region”:“<REGION>”, “accounts”:[{“id”:“<ACCOUNT_ID>”}]}]“

    • excludedResources

      The list of logical resource identifiers to be excluded from the application.

      Type: Array

      Don’t add the resources that you want to include.

      Each excludedResources array item includes the following fields:

      • logicalResourceIds

        Logical identifier of the resource.

        Type: Object

        You can configure only one of the following fields:

        • logicalStackName

        • resourceGroupName

        • terraformSourceName

        • eksSourceName

        Each logicalResourceIds object includes the following fields:

        • identifier

          Identifier of the resource.

          Type: String

        • logicalStackName

          The name of the CloudFormation stack this resource belongs to.

          Type: String

        • resourceGroupName

          The name of the resource group this resource belongs to.

          Type: String

        • terraformSourceName

          The name of the Terraform S3 state file this resource belongs to.

          Type: String

        • eksSourceName

          Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          This parameter accepts values in “eks-cluster/namespace” format.

          Type: String

    • version

      Resilience Hub application version.

    • additionalInfo

      Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

      Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

      Key: “failover-regions”

      Value: “[{“region”:“<REGION>”, “accounts”:[{“id”:“<ACCOUNT_ID>”}]}]“

• On failure, responds with SdkError<DescribeAppVersionTemplateError>

impl Client

pub fn describe_draft_app_version_resources_import_status( &self ) -> DescribeDraftAppVersionResourcesImportStatusFluentBuilder

Constructs a fluent builder for the DescribeDraftAppVersionResourcesImportStatus operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
• On success, responds with DescribeDraftAppVersionResourcesImportStatusOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    The version of the application.

  • status(ResourceImportStatusType):

    Status of the action.

  • status_change_time(DateTime):

    The time when the status last changed.

  • error_message(Option<String>):

    The returned error message for the request.

• On failure, responds with SdkError<DescribeDraftAppVersionResourcesImportStatusError>

impl Client

pub fn describe_resiliency_policy( &self ) -> DescribeResiliencyPolicyFluentBuilder

Constructs a fluent builder for the DescribeResiliencyPolicy operation.

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

    Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
• On success, responds with DescribeResiliencyPolicyOutput with field(s):
  • policy(Option<ResiliencyPolicy>):

    Information about the specific resiliency policy, returned as an object. This object includes creation time, data location constraints, its name, description, tags, the recovery time objective (RTO) and recovery point objective (RPO) in seconds, and more.

• On failure, responds with SdkError<DescribeResiliencyPolicyError>

impl Client

pub fn import_resources_to_draft_app_version( &self ) -> ImportResourcesToDraftAppVersionFluentBuilder

Constructs a fluent builder for the ImportResourcesToDraftAppVersion operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • source_arns(impl Into<String>) / set_source_arns(Option<Vec::<String>>):
    required: false
    

    The Amazon Resource Names (ARNs) for the resources.

    
    
  • terraform_sources(TerraformSource) / set_terraform_sources(Option<Vec::<TerraformSource>>):
    required: false
    

    A list of terraform file s3 URLs you need to import.

    
    
  • import_strategy(ResourceImportStrategyType) / set_import_strategy(Option<ResourceImportStrategyType>):
    required: false
    

    The import strategy you would like to set to import resources into Resilience Hub application.

    
    
  • eks_sources(EksSource) / set_eks_sources(Option<Vec::<EksSource>>):
    required: false
    

    The input sources of the Amazon Elastic Kubernetes Service resources you need to import.

    
    
• On success, responds with ImportResourcesToDraftAppVersionOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    The version of the application.

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

    The Amazon Resource Names (ARNs) for the resources you have imported.

  • status(ResourceImportStatusType):

    Status of the action.

  • terraform_sources(Option<Vec::<TerraformSource>>):

    A list of terraform file s3 URLs you have imported.

  • eks_sources(Option<Vec::<EksSource>>):

    The input sources of the Amazon Elastic Kubernetes Service resources you have imported.

• On failure, responds with SdkError<ImportResourcesToDraftAppVersionError>

impl Client

pub fn list_alarm_recommendations( &self ) -> ListAlarmRecommendationsFluentBuilder

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

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

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

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

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
• On success, responds with ListAlarmRecommendationsOutput with field(s):
  • alarm_recommendations(Vec::<AlarmRecommendation>):

    The alarm recommendations for an Resilience Hub application, returned as an object. This object includes Application Component names, descriptions, information about whether a recommendation has already been implemented or not, prerequisites, and more.

  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListAlarmRecommendationsError>

impl Client

pub fn list_app_assessment_compliance_drifts( &self ) -> ListAppAssessmentComplianceDriftsFluentBuilder

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

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

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

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

    Indicates the unique token number of the next application to be checked for compliance and regulatory requirements from the list of applications.

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

    Indicates the maximum number of applications requested.

    
    
• On success, responds with ListAppAssessmentComplianceDriftsOutput with field(s):
  • compliance_drifts(Vec::<ComplianceDrift>):

    Indicates compliance drifts (recovery time objective (RTO) and recovery point objective (RPO)) detected for an assessed entity.

  • next_token(Option<String>):

    Token number of the next application to be checked for compliance and regulatory requirements from the list of applications.

• On failure, responds with SdkError<ListAppAssessmentComplianceDriftsError>

impl Client

pub fn list_app_assessments(&self) -> ListAppAssessmentsFluentBuilder

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

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • assessment_name(impl Into<String>) / set_assessment_name(Option<String>):
    required: false
    

    The name for the assessment.

    
    
  • assessment_status(AssessmentStatus) / set_assessment_status(Option<Vec::<AssessmentStatus>>):
    required: false
    

    The current status of the assessment for the resiliency policy.

    
    
  • compliance_status(ComplianceStatus) / set_compliance_status(Option<ComplianceStatus>):
    required: false
    

    The current status of compliance for the resiliency policy.

    
    
  • invoker(AssessmentInvoker) / set_invoker(Option<AssessmentInvoker>):
    required: false
    

    Specifies the entity that invoked a specific assessment, either a User or the System.

    
    
  • reverse_order(bool) / set_reverse_order(Option<bool>):
    required: false
    

    The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.

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

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
• On success, responds with ListAppAssessmentsOutput with field(s):
  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

  • assessment_summaries(Vec::<AppAssessmentSummary>):

    The summaries for the specified assessments, returned as an object. This object includes application versions, associated Amazon Resource Numbers (ARNs), cost, messages, resiliency scores, and more.

• On failure, responds with SdkError<ListAppAssessmentsError>

impl Client

pub fn list_app_component_compliances( &self ) -> ListAppComponentCompliancesFluentBuilder

Constructs a fluent builder for the ListAppComponentCompliances 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
    

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
  • assessment_arn(impl Into<String>) / set_assessment_arn(Option<String>):
    required: true
    

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
• On success, responds with ListAppComponentCompliancesOutput with field(s):
  • component_compliances(Vec::<AppComponentCompliance>):

    The compliances for an Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, compliances, costs, resiliency scores, outage scores, and more.

  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListAppComponentCompliancesError>

impl Client

pub fn list_app_component_recommendations( &self ) -> ListAppComponentRecommendationsFluentBuilder

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

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

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

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

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
• On success, responds with ListAppComponentRecommendationsOutput with field(s):
  • component_recommendations(Vec::<ComponentRecommendation>):

    The recommendations for an Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, configuration recommendations, and recommendation statuses.

  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListAppComponentRecommendationsError>

impl Client

pub fn list_app_input_sources(&self) -> ListAppInputSourcesFluentBuilder

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

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • app_version(impl Into<String>) / set_app_version(Option<String>):
    required: true
    

    Resilience Hub application version.

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

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of input sources to be displayed per Resilience Hub application.

    
    
• On success, responds with ListAppInputSourcesOutput with field(s):
  • app_input_sources(Vec::<AppInputSource>):

    The list of Resilience Hub application input sources.

  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListAppInputSourcesError>

impl Client

pub fn list_app_version_app_components( &self ) -> ListAppVersionAppComponentsFluentBuilder

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

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • app_version(impl Into<String>) / set_app_version(Option<String>):
    required: true
    

    Version of the Application Component.

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

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of Application Components to be displayed per Resilience Hub application version.

    
    
• On success, responds with ListAppVersionAppComponentsOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    Resilience Hub application version.

  • app_components(Option<Vec::<AppComponent>>):

    Defines an Application Component.

  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListAppVersionAppComponentsError>

impl Client

pub fn list_app_version_resource_mappings( &self ) -> ListAppVersionResourceMappingsFluentBuilder

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

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • app_version(impl Into<String>) / set_app_version(Option<String>):
    required: true
    

    The version of the application.

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

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
• On success, responds with ListAppVersionResourceMappingsOutput with field(s):
  • resource_mappings(Vec::<ResourceMapping>):

    Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.

  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListAppVersionResourceMappingsError>

impl Client

pub fn list_app_version_resources(&self) -> ListAppVersionResourcesFluentBuilder

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

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • app_version(impl Into<String>) / set_app_version(Option<String>):
    required: true
    

    The version of the application.

    
    
  • resolution_id(impl Into<String>) / set_resolution_id(Option<String>):
    required: false
    

    The identifier for a specific resolution.

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

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
• On success, responds with ListAppVersionResourcesOutput with field(s):
  • physical_resources(Vec::<PhysicalResource>):

    The physical resources in the application version.

  • resolution_id(String):

    The ID for a specific resolution.

  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListAppVersionResourcesError>

impl Client

pub fn list_app_versions(&self) -> ListAppVersionsFluentBuilder

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

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

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

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    Lower limit of the time range to filter the application versions.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    Upper limit of the time range to filter the application versions.

    
    
• On success, responds with ListAppVersionsOutput with field(s):
  • app_versions(Vec::<AppVersionSummary>):

    The version of the application.

  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListAppVersionsError>

impl Client

pub fn list_apps(&self) -> ListAppsFluentBuilder

Constructs a fluent builder for the ListApps 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
    

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name for the one of the listed applications.

    
    
  • app_arn(impl Into<String>) / set_app_arn(Option<String>):
    required: false
    

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • from_last_assessment_time(DateTime) / set_from_last_assessment_time(Option<DateTime>):
    required: false
    

    Indicates the lower limit of the range that is used to filter applications based on their last assessment times.

    
    
  • to_last_assessment_time(DateTime) / set_to_last_assessment_time(Option<DateTime>):
    required: false
    

    Indicates the upper limit of the range that is used to filter the applications based on their last assessment times.

    
    
  • reverse_order(bool) / set_reverse_order(Option<bool>):
    required: false
    

    The application list is sorted based on the values of lastAppComplianceEvaluationTime field. By default, application list is sorted in ascending order. To sort the appliation list in descending order, set this field to True.

    
    
• On success, responds with ListAppsOutput with field(s):
  • app_summaries(Vec::<AppSummary>):

    Summaries for the Resilience Hub application.

  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListAppsError>

impl Client

pub fn list_recommendation_templates( &self ) -> ListRecommendationTemplatesFluentBuilder

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

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

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • reverse_order(bool) / set_reverse_order(Option<bool>):
    required: false
    

    The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.

    
    
  • status(RecommendationTemplateStatus) / set_status(Option<Vec::<RecommendationTemplateStatus>>):
    required: false
    

    Status of the action.

    
    
  • recommendation_template_arn(impl Into<String>) / set_recommendation_template_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) for a recommendation template.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name for one of the listed recommendation templates.

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

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
• On success, responds with ListRecommendationTemplatesOutput with field(s):
  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

  • recommendation_templates(Option<Vec::<RecommendationTemplate>>):

    The recommendation templates for the Resilience Hub applications.

• On failure, responds with SdkError<ListRecommendationTemplatesError>

impl Client

pub fn list_resiliency_policies(&self) -> ListResiliencyPoliciesFluentBuilder

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

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

    The name of the policy

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

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
• On success, responds with ListResiliencyPoliciesOutput with field(s):
  • resiliency_policies(Vec::<ResiliencyPolicy>):

    The resiliency policies for the Resilience Hub applications.

  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListResiliencyPoliciesError>

impl Client

pub fn list_sop_recommendations(&self) -> ListSopRecommendationsFluentBuilder

Constructs a fluent builder for the ListSopRecommendations 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
    

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
  • assessment_arn(impl Into<String>) / set_assessment_arn(Option<String>):
    required: true
    

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
• On success, responds with ListSopRecommendationsOutput with field(s):
  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

  • sop_recommendations(Vec::<SopRecommendation>):

    The standard operating procedure (SOP) recommendations for the Resilience Hub applications.

• On failure, responds with SdkError<ListSopRecommendationsError>

impl Client

pub fn list_suggested_resiliency_policies( &self ) -> ListSuggestedResiliencyPoliciesFluentBuilder

Constructs a fluent builder for the ListSuggestedResiliencyPolicies 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
    

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
• On success, responds with ListSuggestedResiliencyPoliciesOutput with field(s):
  • resiliency_policies(Vec::<ResiliencyPolicy>):

    The suggested resiliency policies for the Resilience Hub applications.

  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListSuggestedResiliencyPoliciesError>

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) for a specific resource in your Resilience Hub application.

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

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_test_recommendations(&self) -> ListTestRecommendationsFluentBuilder

Constructs a fluent builder for the ListTestRecommendations 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
    

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
  • assessment_arn(impl Into<String>) / set_assessment_arn(Option<String>):
    required: true
    

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
• On success, responds with ListTestRecommendationsOutput with field(s):
  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

  • test_recommendations(Vec::<TestRecommendation>):

    The test recommendations for the Resilience Hub application.

• On failure, responds with SdkError<ListTestRecommendationsError>

impl Client

pub fn list_unsupported_app_version_resources( &self ) -> ListUnsupportedAppVersionResourcesFluentBuilder

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

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • app_version(impl Into<String>) / set_app_version(Option<String>):
    required: true
    

    The version of the application.

    
    
  • resolution_id(impl Into<String>) / set_resolution_id(Option<String>):
    required: false
    

    The identifier for a specific resolution.

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

    Null, or the token from a previous call to get the next set of results.

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

    Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
• On success, responds with ListUnsupportedAppVersionResourcesOutput with field(s):
  • unsupported_resources(Vec::<UnsupportedResource>):

    The unsupported resources for the application.

  • resolution_id(String):

    The identifier for a specific resolution.

  • next_token(Option<String>):

    Token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListUnsupportedAppVersionResourcesError>

impl Client

pub fn publish_app_version(&self) -> PublishAppVersionFluentBuilder

Constructs a fluent builder for the PublishAppVersion operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: false
    

    Name of the application version.

    
    
• On success, responds with PublishAppVersionOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(Option<String>):

    The version of the application.

  • identifier(Option<i64>):

    Identifier of the application version.

  • version_name(Option<String>):

    Name of the application version.

• On failure, responds with SdkError<PublishAppVersionError>

impl Client

pub fn put_draft_app_version_template( &self ) -> PutDraftAppVersionTemplateFluentBuilder

Constructs a fluent builder for the PutDraftAppVersionTemplate operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • app_template_body(impl Into<String>) / set_app_template_body(Option<String>):
    required: true
    

    A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.

    The appTemplateBody JSON string has the following structure:

    • resources

      The list of logical resources that must be included in the Resilience Hub application.

      Type: Array

      Don’t add the resources that you want to exclude.

      Each resources array item includes the following fields:

      • logicalResourceId

        Logical identifier of the resource.

        Type: Object

        Each logicalResourceId object includes the following fields:

        • identifier

          Identifier of the resource.

          Type: String

        • logicalStackName

          The name of the CloudFormation stack this resource belongs to.

          Type: String

        • resourceGroupName

          The name of the resource group this resource belongs to.

          Type: String

        • terraformSourceName

          The name of the Terraform S3 state file this resource belongs to.

          Type: String

        • eksSourceName

          Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          This parameter accepts values in “eks-cluster/namespace” format.

          Type: String

      • type

        The type of resource.

        Type: string

      • name

        The name of the resource.

        Type: String

      • additionalInfo

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        Key: “failover-regions”

        Value: “[{“region”:“<REGION>”, “accounts”:[{“id”:“<ACCOUNT_ID>”}]}]“

    • appComponents

      List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

      Type: Array

      Each appComponents array item includes the following fields:

      • name

        Name of the Application Component.

        Type: String

      • type

        Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

        Type: String

      • resourceNames

        The list of included resources that are assigned to the Application Component.

        Type: Array of strings

      • additionalInfo

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        Key: “failover-regions”

        Value: “[{“region”:“<REGION>”, “accounts”:[{“id”:“<ACCOUNT_ID>”}]}]“

    • excludedResources

      The list of logical resource identifiers to be excluded from the application.

      Type: Array

      Don’t add the resources that you want to include.

      Each excludedResources array item includes the following fields:

      • logicalResourceIds

        Logical identifier of the resource.

        Type: Object

        You can configure only one of the following fields:

        • logicalStackName

        • resourceGroupName

        • terraformSourceName

        • eksSourceName

        Each logicalResourceIds object includes the following fields:

        • identifier

          Identifier of the resource.

          Type: String

        • logicalStackName

          The name of the CloudFormation stack this resource belongs to.

          Type: String

        • resourceGroupName

          The name of the resource group this resource belongs to.

          Type: String

        • terraformSourceName

          The name of the Terraform S3 state file this resource belongs to.

          Type: String

        • eksSourceName

          Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          This parameter accepts values in “eks-cluster/namespace” format.

          Type: String

    • version

      Resilience Hub application version.

    • additionalInfo

      Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

      Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

      Key: “failover-regions”

      Value: “[{“region”:“<REGION>”, “accounts”:[{“id”:“<ACCOUNT_ID>”}]}]“

    
    
• On success, responds with PutDraftAppVersionTemplateOutput with field(s):
  • app_arn(Option<String>):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(Option<String>):

    The version of the application.

• On failure, responds with SdkError<PutDraftAppVersionTemplateError>

impl Client

pub fn remove_draft_app_version_resource_mappings( &self ) -> RemoveDraftAppVersionResourceMappingsFluentBuilder

Constructs a fluent builder for the RemoveDraftAppVersionResourceMappings operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • resource_names(impl Into<String>) / set_resource_names(Option<Vec::<String>>):
    required: false
    

    The names of the resources you want to remove from the resource mappings.

    
    
  • logical_stack_names(impl Into<String>) / set_logical_stack_names(Option<Vec::<String>>):
    required: false
    

    The names of the CloudFormation stacks you want to remove from the resource mappings.

    
    
  • app_registry_app_names(impl Into<String>) / set_app_registry_app_names(Option<Vec::<String>>):
    required: false
    

    The names of the registered applications you want to remove from the resource mappings.

    
    
  • resource_group_names(impl Into<String>) / set_resource_group_names(Option<Vec::<String>>):
    required: false
    

    The names of the resource groups you want to remove from the resource mappings.

    
    
  • terraform_source_names(impl Into<String>) / set_terraform_source_names(Option<Vec::<String>>):
    required: false
    

    The names of the Terraform sources you want to remove from the resource mappings.

    
    
  • eks_source_names(impl Into<String>) / set_eks_source_names(Option<Vec::<String>>):
    required: false
    

    The names of the Amazon Elastic Kubernetes Service clusters and namespaces you want to remove from the resource mappings.

    This parameter accepts values in “eks-cluster/namespace” format.

    
    
• On success, responds with RemoveDraftAppVersionResourceMappingsOutput with field(s):
  • app_arn(Option<String>):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(Option<String>):

    The version of the application.

• On failure, responds with SdkError<RemoveDraftAppVersionResourceMappingsError>

impl Client

pub fn resolve_app_version_resources( &self ) -> ResolveAppVersionResourcesFluentBuilder

Constructs a fluent builder for the ResolveAppVersionResources operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • app_version(impl Into<String>) / set_app_version(Option<String>):
    required: true
    

    The version of the application.

    
    
• On success, responds with ResolveAppVersionResourcesOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    The version of the application.

  • resolution_id(String):

    The identifier for a specific resolution.

  • status(ResourceResolutionStatusType):

    Status of the action.

• On failure, responds with SdkError<ResolveAppVersionResourcesError>

impl Client

pub fn start_app_assessment(&self) -> StartAppAssessmentFluentBuilder

Constructs a fluent builder for the StartAppAssessment operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • app_version(impl Into<String>) / set_app_version(Option<String>):
    required: true
    

    The version of the application.

    
    
  • assessment_name(impl Into<String>) / set_assessment_name(Option<String>):
    required: true
    

    The name for the assessment.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

    
    
• On success, responds with StartAppAssessmentOutput with field(s):
  • assessment(Option<AppAssessment>):

    The assessment created.

• On failure, responds with SdkError<StartAppAssessmentError>

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
    

    Amazon Resource Name (ARN) of the resource.

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

    The tags to assign to the resource. Each tag consists of a key/value pair.

    
    
• 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
    

    Amazon Resource Name (ARN) of the resource.

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

    The keys of the tags you want to remove.

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

impl Client

pub fn update_app(&self) -> UpdateAppFluentBuilder

Constructs a fluent builder for the UpdateApp operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The optional description for an app.

    
    
  • policy_arn(impl Into<String>) / set_policy_arn(Option<String>):
    required: false
    

    Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • clear_resiliency_policy_arn(bool) / set_clear_resiliency_policy_arn(Option<bool>):
    required: false
    

    Specifies if the resiliency policy ARN should be cleared.

    
    
  • assessment_schedule(AppAssessmentScheduleType) / set_assessment_schedule(Option<AppAssessmentScheduleType>):
    required: false
    

    Assessment execution schedule with ‘Daily’ or ‘Disabled’ values.

    
    
  • permission_model(PermissionModel) / set_permission_model(Option<PermissionModel>):
    required: false
    

    Defines the roles and credentials that Resilience Hub would use while creating an application, importing its resources, and running an assessment.

    
    
  • event_subscriptions(EventSubscription) / set_event_subscriptions(Option<Vec::<EventSubscription>>):
    required: false
    

    The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.

    
    
• On success, responds with UpdateAppOutput with field(s):
  • app(Option<App>):

    The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.

• On failure, responds with SdkError<UpdateAppError>

impl Client

pub fn update_app_version(&self) -> UpdateAppVersionFluentBuilder

Constructs a fluent builder for the UpdateAppVersion operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • additional_info(impl Into<String>, Vec::<String>) / set_additional_info(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

    Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

    Key: “failover-regions”

    Value: “[{“region”:“<REGION>”, “accounts”:[{“id”:“<ACCOUNT_ID>”}]}]“

    
    
• On success, responds with UpdateAppVersionOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    Resilience Hub application version.

  • additional_info(Option<HashMap::<String, Vec::<String>>>):

    Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

    Currently, this parameter supports only failover region and account.

• On failure, responds with SdkError<UpdateAppVersionError>

impl Client

pub fn update_app_version_app_component( &self ) -> UpdateAppVersionAppComponentFluentBuilder

Constructs a fluent builder for the UpdateAppVersionAppComponent operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    Identifier of the Application Component.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    Name of the Application Component.

    
    
  • r#type(impl Into<String>) / set_type(Option<String>):
    required: false
    

    Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

    
    
  • additional_info(impl Into<String>, Vec::<String>) / set_additional_info(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    Currently, there is no supported additional information for Application Components.

    
    
• On success, responds with UpdateAppVersionAppComponentOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    Resilience Hub application version.

  • app_component(Option<AppComponent>):

    List of Application Components that belong to this resource.

• On failure, responds with SdkError<UpdateAppVersionAppComponentError>

impl Client

pub fn update_app_version_resource( &self ) -> UpdateAppVersionResourceFluentBuilder

Constructs a fluent builder for the UpdateAppVersionResource operation.

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

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: false
    

    Name of the resource.

    
    
  • logical_resource_id(LogicalResourceId) / set_logical_resource_id(Option<LogicalResourceId>):
    required: false
    

    Logical identifier of the resource.

    
    
  • physical_resource_id(impl Into<String>) / set_physical_resource_id(Option<String>):
    required: false
    

    Physical identifier of the resource.

    
    
  • aws_region(impl Into<String>) / set_aws_region(Option<String>):
    required: false
    

    Amazon Web Services region that owns the physical resource.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: false
    

    Amazon Web Services account that owns the physical resource.

    
    
  • resource_type(impl Into<String>) / set_resource_type(Option<String>):
    required: false
    

    Type of resource.

    
    
  • app_components(impl Into<String>) / set_app_components(Option<Vec::<String>>):
    required: false
    

    List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

    
    
  • additional_info(impl Into<String>, Vec::<String>) / set_additional_info(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    Currently, there is no supported additional information for resources.

    
    
  • excluded(bool) / set_excluded(Option<bool>):
    required: false
    

    Indicates if a resource is excluded from an Resilience Hub application.

    You can exclude only imported resources from an Resilience Hub application.

    
    
• On success, responds with UpdateAppVersionResourceOutput with field(s):
  • app_arn(String):

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version(String):

    Resilience Hub application version.

  • physical_resource(Option<PhysicalResource>):

    Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.

• On failure, responds with SdkError<UpdateAppVersionResourceError>

impl Client

pub fn update_resiliency_policy(&self) -> UpdateResiliencyPolicyFluentBuilder

Constructs a fluent builder for the UpdateResiliencyPolicy operation.

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

    Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    
    
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: false
    

    The name of the policy

    
    
  • policy_description(impl Into<String>) / set_policy_description(Option<String>):
    required: false
    

    The description for the policy.

    
    
  • data_location_constraint(DataLocationConstraint) / set_data_location_constraint(Option<DataLocationConstraint>):
    required: false
    

    Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

    
    
  • tier(ResiliencyPolicyTier) / set_tier(Option<ResiliencyPolicyTier>):
    required: false
    

    The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

    
    
  • policy(DisruptionType, FailurePolicy) / set_policy(Option<HashMap::<DisruptionType, FailurePolicy>>):
    required: false
    

    The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

    
    
• On success, responds with UpdateResiliencyPolicyOutput with field(s):
  • policy(Option<ResiliencyPolicy>):

    The type of resiliency policy that was updated, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

• On failure, responds with SdkError<UpdateResiliencyPolicyError>

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