aws-sdk-resiliencehub 1.43.0 → 1.45.0

data/lib/aws-sdk-resiliencehub/types.rb

@@ -38,8 +38,8 @@ module Aws::ResilienceHub
     #   @return [String]
     #
     # @!attribute [rw] entries
-    #   Indicates the list of resource grouping recommendations you want to
-    #   include in your application.
+    #   List of resource grouping recommendations you want to include in
+    #   your application.
     #   @return [Array<Types::AcceptGroupingRecommendationEntry>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/AcceptResourceGroupingRecommendationsRequest AWS API Documentation
@@ -64,8 +64,8 @@ module Aws::ResilienceHub
     #   @return [String]
     #
     # @!attribute [rw] failed_entries
-    #   Indicates the list of resource grouping recommendations that could
-    #   not be included in your application.
+    #   List of resource grouping recommendations that could not be included
+    #   in your application.
     #   @return [Array<Types::FailedGroupingRecommendationEntry>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/AcceptResourceGroupingRecommendationsResponse AWS API Documentation
@@ -155,6 +155,29 @@ module Aws::ResilienceHub
       include Aws::Structure
     end
 
+    # Indicates the Amazon CloudWatch alarm detected while running an
+    # assessment.
+    #
+    # @!attribute [rw] alarm_arn
+    #   Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
+    #   @return [String]
+    #
+    # @!attribute [rw] source
+    #   Indicates the source of the Amazon CloudWatch alarm. That is, it
+    #   indicates if the alarm was created using Resilience Hub
+    #   recommendation (`AwsResilienceHub`), or if you had created the alarm
+    #   in Amazon CloudWatch (`Customer`).
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/Alarm AWS API Documentation
+    #
+    class Alarm < Struct.new(
+      :alarm_arn,
+      :source)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Defines a recommendation for a CloudWatch alarm.
     #
     # @!attribute [rw] app_component_name
@@ -251,7 +274,7 @@ module Aws::ResilienceHub
     #   @return [String]
     #
     # @!attribute [rw] creation_time
-    #   Date and time when the app was created.
+    #   Date and time when the application was created.
     #   @return [Time]
     #
     # @!attribute [rw] description
@@ -846,7 +869,7 @@ module Aws::ResilienceHub
     #
     # @!attribute [rw] app_components
     #   Indicates the Application Components (AppComponents) that were
-    #   assessed as part of the assessnent and are associated with the
+    #   assessed as part of the assessment and are associated with the
     #   identified risk and recommendation.
     #
     #   <note markdown="1"> This property is available only in the US East (N. Virginia) Region.
@@ -1005,6 +1028,10 @@ module Aws::ResilienceHub
     # List of operational recommendations that were successfully included or
     # excluded.
     #
+    # @!attribute [rw] app_component_id
+    #   Indicates the identifier of an AppComponent.
+    #   @return [String]
+    #
     # @!attribute [rw] entry_id
     #   An identifier for an entry in this batch that is used to communicate
     #   the result.
@@ -1035,6 +1062,7 @@ module Aws::ResilienceHub
     # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/BatchUpdateRecommendationStatusSuccessfulEntry AWS API Documentation
     #
     class BatchUpdateRecommendationStatusSuccessfulEntry < Struct.new(
+      :app_component_id,
       :entry_id,
       :exclude_reason,
       :excluded,
@@ -1141,6 +1169,31 @@ module Aws::ResilienceHub
       include Aws::Structure
     end
 
+    # Indicates the condition based on which you want to filter the metrics.
+    #
+    # @!attribute [rw] field
+    #   Indicates the field in the metric.
+    #   @return [String]
+    #
+    # @!attribute [rw] operator
+    #   Indicates the type of operator or comparison to be used when
+    #   evaluating a condition against the specified field.
+    #   @return [String]
+    #
+    # @!attribute [rw] value
+    #   Indicates the value or data against which a condition is evaluated.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/Condition AWS API Documentation
+    #
+    class Condition < Struct.new(
+      :field,
+      :operator,
+      :value)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Defines a recommendation configuration.
     #
     # @!attribute [rw] app_component_name
@@ -1656,11 +1709,11 @@ module Aws::ResilienceHub
     #   @return [Hash<String,Types::FailurePolicy>]
     #
     # @!attribute [rw] policy_description
-    #   The description for the policy.
+    #   Description of the resiliency policy.
     #   @return [String]
     #
     # @!attribute [rw] policy_name
-    #   The name of the policy
+    #   Name of the resiliency policy.
     #   @return [String]
     #
     # @!attribute [rw] tags
@@ -2834,6 +2887,46 @@ module Aws::ResilienceHub
       include Aws::Structure
     end
 
+    # @!attribute [rw] metrics_export_id
+    #   Identifier of the metrics export task.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DescribeMetricsExportRequest AWS API Documentation
+    #
+    class DescribeMetricsExportRequest < Struct.new(
+      :metrics_export_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] error_message
+    #   Explains the error that occurred while exporting the metrics.
+    #   @return [String]
+    #
+    # @!attribute [rw] export_location
+    #   Specifies the name of the Amazon S3 bucket where the exported
+    #   metrics is stored.
+    #   @return [Types::S3Location]
+    #
+    # @!attribute [rw] metrics_export_id
+    #   Identifier for the metrics export task.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   Indicates the status of the metrics export task.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DescribeMetricsExportResponse AWS API Documentation
+    #
+    class DescribeMetricsExportResponse < Struct.new(
+      :error_message,
+      :export_location,
+      :metrics_export_id,
+      :status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] policy_arn
     #   Amazon Resource Name (ARN) of the resiliency policy. The format for
     #   this ARN is:
@@ -2883,7 +2976,7 @@ module Aws::ResilienceHub
     #   @return [String]
     #
     # @!attribute [rw] grouping_id
-    #   Indicates the identifier of the grouping recommendation task.
+    #   Identifier of the grouping recommendation task.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DescribeResourceGroupingRecommendationTaskRequest AWS API Documentation
@@ -2896,12 +2989,11 @@ module Aws::ResilienceHub
     end
 
     # @!attribute [rw] error_message
-    #   Indicates the error that occurred while generating a grouping
-    #   recommendation.
+    #   Error that occurred while generating a grouping recommendation.
     #   @return [String]
     #
     # @!attribute [rw] grouping_id
-    #   Indicates the identifier of the grouping recommendation task.
+    #   Identifier of the grouping recommendation task.
     #   @return [String]
     #
     # @!attribute [rw] status
@@ -3085,6 +3177,25 @@ module Aws::ResilienceHub
       include Aws::Structure
     end
 
+    # Indicates the FIS experiment detected while running an assessment.
+    #
+    # @!attribute [rw] experiment_arn
+    #   Amazon Resource Name (ARN) of the FIS experiment.
+    #   @return [String]
+    #
+    # @!attribute [rw] experiment_template_id
+    #   Identifier of the FIS experiment template.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/Experiment AWS API Documentation
+    #
+    class Experiment < Struct.new(
+      :experiment_arn,
+      :experiment_template_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Indicates the accepted grouping recommendation whose implementation
     # failed.
     #
@@ -3125,6 +3236,28 @@ module Aws::ResilienceHub
       include Aws::Structure
     end
 
+    # Indicates the field or attribute of a resource or data structure on
+    # which a condition is being applied or evaluated.
+    #
+    # @!attribute [rw] aggregation
+    #   (Optional) Indicates the type of aggregation or summary operation
+    #   (such as Sum, Average, and so on) to be performed on a particular
+    #   field or set of data.
+    #   @return [String]
+    #
+    # @!attribute [rw] name
+    #   Name of the field.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/Field AWS API Documentation
+    #
+    class Field < Struct.new(
+      :aggregation,
+      :name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Creates a new recommended Application Component (AppComponent).
     #
     # @!attribute [rw] app_component_id
@@ -3416,7 +3549,7 @@ module Aws::ResilienceHub
     #   @return [String]
     #
     # @!attribute [rw] max_results
-    #   Indicates the maximum number of compliance drifts requested.
+    #   Maximum number of compliance drifts requested.
     #   @return [Integer]
     #
     # @!attribute [rw] next_token
@@ -3466,10 +3599,10 @@ module Aws::ResilienceHub
     #   @return [String]
     #
     # @!attribute [rw] max_results
-    #   Indicates the maximum number of drift 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.
+    #   Maximum number of drift 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.
     #   @return [Integer]
     #
     # @!attribute [rw] next_token
@@ -4040,8 +4173,8 @@ module Aws::ResilienceHub
     #   @return [String]
     #
     # @!attribute [rw] from_last_assessment_time
-    #   Indicates the lower limit of the range that is used to filter
-    #   applications based on their last assessment times.
+    #   Lower limit of the range that is used to filter applications based
+    #   on their last assessment times.
     #   @return [Time]
     #
     # @!attribute [rw] max_results
@@ -4068,8 +4201,8 @@ module Aws::ResilienceHub
     #   @return [Boolean]
     #
     # @!attribute [rw] to_last_assessment_time
-    #   Indicates the upper limit of the range that is used to filter the
-    #   applications based on their last assessment times.
+    #   Upper limit of the range that is used to filter the applications
+    #   based on their last assessment times.
     #   @return [Time]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListAppsRequest AWS API Documentation
@@ -4105,6 +4238,68 @@ module Aws::ResilienceHub
       include Aws::Structure
     end
 
+    # @!attribute [rw] conditions
+    #   Indicates the list of all the conditions that were applied on the
+    #   metrics.
+    #   @return [Array<Types::Condition>]
+    #
+    # @!attribute [rw] data_source
+    #   Indicates the data source of the metrics.
+    #   @return [String]
+    #
+    # @!attribute [rw] fields
+    #   Indicates the list of fields in the data source.
+    #   @return [Array<Types::Field>]
+    #
+    # @!attribute [rw] max_results
+    #   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.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   Null, or the token from a previous call to get the next set of
+    #   results.
+    #   @return [String]
+    #
+    # @!attribute [rw] sorts
+    #   (Optional) Indicates the order in which you want to sort the fields
+    #   in the metrics. By default, the fields are sorted in the ascending
+    #   order.
+    #   @return [Array<Types::Sort>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListMetricsRequest AWS API Documentation
+    #
+    class ListMetricsRequest < Struct.new(
+      :conditions,
+      :data_source,
+      :fields,
+      :max_results,
+      :next_token,
+      :sorts)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] next_token
+    #   Token for the next set of results, or null if there are no more
+    #   results.
+    #   @return [String]
+    #
+    # @!attribute [rw] rows
+    #   Specifies all the list of metric values for each row of metrics.
+    #   @return [Array<Array<String>>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListMetricsResponse AWS API Documentation
+    #
+    class ListMetricsResponse < Struct.new(
+      :next_token,
+      :rows)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] assessment_arn
     #   Amazon Resource Name (ARN) of the assessment. The format for this
     #   ARN is:
@@ -4191,7 +4386,7 @@ module Aws::ResilienceHub
     #   @return [String]
     #
     # @!attribute [rw] policy_name
-    #   The name of the policy
+    #   Name of the resiliency policy.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListResiliencyPoliciesRequest AWS API Documentation
@@ -4576,6 +4771,11 @@ module Aws::ResilienceHub
     #   Principle to obtain a read-only access to your application resources
     #   while running an assessment.
     #
+    #   If your IAM role includes a path, you must include the path in the
+    #   `invokerRoleName` parameter. For example, if your IAM role's ARN is
+    #   `arn:aws:iam:123456789012:role/my-path/role-name`, you should pass
+    #   `my-path/role-name`.
+    #
     #   <note markdown="1"> * You must have `iam:passRole` permission for this role while
     #     creating or updating the application.
     #
@@ -5150,6 +5350,11 @@ module Aws::ResilienceHub
     #   Specifies if the recommendation has already been implemented.
     #   @return [Boolean]
     #
+    # @!attribute [rw] discovered_alarm
+    #   Indicates the previously implemented Amazon CloudWatch alarm
+    #   discovered by Resilience Hub.
+    #   @return [Types::Alarm]
+    #
     # @!attribute [rw] exclude_reason
     #   Indicates the reason for excluding an operational recommendation.
     #   @return [String]
@@ -5158,6 +5363,11 @@ module Aws::ResilienceHub
     #   Indicates if an operational recommendation item is excluded.
     #   @return [Boolean]
     #
+    # @!attribute [rw] latest_discovered_experiment
+    #   Indicates the experiment created in FIS that was discovered by
+    #   Resilience Hub, which matches the recommendation.
+    #   @return [Types::Experiment]
+    #
     # @!attribute [rw] resource_id
     #   Identifier of the resource.
     #   @return [String]
@@ -5174,8 +5384,10 @@ module Aws::ResilienceHub
     #
     class RecommendationItem < Struct.new(
       :already_implemented,
+      :discovered_alarm,
       :exclude_reason,
       :excluded,
+      :latest_discovered_experiment,
       :resource_id,
       :target_account_id,
       :target_region)
@@ -5336,8 +5548,8 @@ module Aws::ResilienceHub
     #   @return [String]
     #
     # @!attribute [rw] entries
-    #   Indicates the list of resource grouping recommendations you have
-    #   selected to exclude from your application.
+    #   List of resource grouping recommendations you have selected to
+    #   exclude from your application.
     #   @return [Array<Types::RejectGroupingRecommendationEntry>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/RejectResourceGroupingRecommendationsRequest AWS API Documentation
@@ -5362,8 +5574,8 @@ module Aws::ResilienceHub
     #   @return [String]
     #
     # @!attribute [rw] failed_entries
-    #   Indicates the list of resource grouping recommendations that failed
-    #   to get excluded in your application.
+    #   List of resource grouping recommendations that failed to get
+    #   excluded in your application.
     #   @return [Array<Types::FailedGroupingRecommendationEntry>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/RejectResourceGroupingRecommendationsResponse AWS API Documentation
@@ -5502,7 +5714,7 @@ module Aws::ResilienceHub
     #   @return [String]
     #
     # @!attribute [rw] policy_description
-    #   The description for the policy.
+    #   Description of the resiliency policy.
     #   @return [String]
     #
     # @!attribute [rw] policy_name
@@ -5955,6 +6167,28 @@ module Aws::ResilienceHub
       include Aws::Structure
     end
 
+    # Indicates the sorting order of the fields in the metrics.
+    #
+    # @!attribute [rw] ascending
+    #   Indicates the name or identifier of the field or attribute that
+    #   should be used as the basis for sorting the metrics.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] field
+    #   Indicates the order in which you want to sort the metrics. By
+    #   default, the list is sorted in ascending order. To sort the list in
+    #   descending order, set this field to False.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/Sort AWS API Documentation
+    #
+    class Sort < Struct.new(
+      :ascending,
+      :field)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] app_arn
     #   Amazon Resource Name (ARN) of the Resilience Hub application. The
     #   format for this ARN is:
@@ -6014,6 +6248,46 @@ module Aws::ResilienceHub
       include Aws::Structure
     end
 
+    # @!attribute [rw] bucket_name
+    #   (Optional) Specifies the name of the Amazon Simple Storage Service
+    #   bucket where the exported metrics will be stored.
+    #   @return [String]
+    #
+    # @!attribute [rw] client_token
+    #   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.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/StartMetricsExportRequest AWS API Documentation
+    #
+    class StartMetricsExportRequest < Struct.new(
+      :bucket_name,
+      :client_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] metrics_export_id
+    #   Identifier of the metrics export task.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   Indicates the status of the metrics export task.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/StartMetricsExportResponse AWS API Documentation
+    #
+    class StartMetricsExportResponse < Struct.new(
+      :metrics_export_id,
+      :status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] app_arn
     #   Amazon Resource Name (ARN) of the Resilience Hub application. The
     #   format for this ARN is:
@@ -6047,12 +6321,11 @@ module Aws::ResilienceHub
     #   @return [String]
     #
     # @!attribute [rw] error_message
-    #   Indicates the error that occurred while executing a grouping
-    #   recommendation task.
+    #   Error that occurred while executing a grouping recommendation task.
     #   @return [String]
     #
     # @!attribute [rw] grouping_id
-    #   Indicates the identifier of the grouping recommendation task.
+    #   Identifier of the grouping recommendation task.
     #   @return [String]
     #
     # @!attribute [rw] status
@@ -6108,6 +6381,10 @@ module Aws::ResilienceHub
 
     # Defines a test recommendation.
     #
+    # @!attribute [rw] app_component_id
+    #   Indicates the identifier of the AppComponent.
+    #   @return [String]
+    #
     # @!attribute [rw] app_component_name
     #   Name of the Application Component.
     #   @return [String]
@@ -6160,6 +6437,7 @@ module Aws::ResilienceHub
     # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/TestRecommendation AWS API Documentation
     #
     class TestRecommendation < Struct.new(
+      :app_component_id,
       :app_component_name,
       :depends_on_alarms,
       :description,
@@ -6615,6 +6893,10 @@ module Aws::ResilienceHub
     # Defines the operational recommendation item that is to be included or
     # excluded.
     #
+    # @!attribute [rw] app_component_id
+    #   Indicates the identifier of the AppComponent.
+    #   @return [String]
+    #
     # @!attribute [rw] entry_id
     #   An identifier for an entry in this batch that is used to communicate
     #   the result.
@@ -6645,6 +6927,7 @@ module Aws::ResilienceHub
     # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/UpdateRecommendationStatusRequestEntry AWS API Documentation
     #
     class UpdateRecommendationStatusRequestEntry < Struct.new(
+      :app_component_id,
       :entry_id,
       :exclude_reason,
       :excluded,
@@ -6660,8 +6943,8 @@ module Aws::ResilienceHub
     #   @return [String]
     #
     # @!attribute [rw] policy
-    #   The type of resiliency policy to be created, including the recovery
-    #   time objective (RTO) and recovery point objective (RPO) in seconds.
+    #   Resiliency policy to be created, including the recovery time
+    #   objective (RTO) and recovery point objective (RPO) in seconds.
     #   @return [Hash<String,Types::FailurePolicy>]
     #
     # @!attribute [rw] policy_arn
@@ -6677,11 +6960,11 @@ module Aws::ResilienceHub
     #   @return [String]
     #
     # @!attribute [rw] policy_description
-    #   The description for the policy.
+    #   Description of the resiliency policy.
     #   @return [String]
     #
     # @!attribute [rw] policy_name
-    #   The name of the policy
+    #   Name of the resiliency policy.
     #   @return [String]
     #
     # @!attribute [rw] tier
@@ -6703,9 +6986,8 @@ module Aws::ResilienceHub
     end
 
     # @!attribute [rw] policy
-    #   The type of resiliency policy that was updated, including the
-    #   recovery time objective (RTO) and recovery point objective (RPO) in
-    #   seconds.
+    #   The resiliency policy that was updated, including the recovery time
+    #   objective (RTO) and recovery point objective (RPO) in seconds.
     #   @return [Types::ResiliencyPolicy]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/UpdateResiliencyPolicyResponse AWS API Documentation

data/lib/aws-sdk-resiliencehub.rb

@@ -54,7 +54,7 @@ module Aws::ResilienceHub
   autoload :EndpointProvider, 'aws-sdk-resiliencehub/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-resiliencehub/endpoints'
 
-  GEM_VERSION = '1.43.0'
+  GEM_VERSION = '1.45.0'
 
 end