Class: Aws::Resiliencehubv2::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Resiliencehubv2::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb
Overview
An API client for Resiliencehubv2. To construct a client, you need to configure a :region and :credentials.
client = Aws::Resiliencehubv2::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_assertion(params = {}) ⇒ Types::CreateAssertionResponse
Creates a resilience assertion for a service.
-
#create_input_source(params = {}) ⇒ Types::CreateInputSourceResponse
Creates an input source for a service.
-
#create_policy(params = {}) ⇒ Types::CreatePolicyResponse
Creates a resilience policy that defines availability and disaster recovery requirements.
-
#create_report(params = {}) ⇒ Types::CreateReportResponse
On-demand report creation.
-
#create_service(params = {}) ⇒ Types::CreateServiceResponse
Creates a service.
-
#create_service_function(params = {}) ⇒ Types::CreateServiceFunctionResponse
Creates a service function within a service.
-
#create_service_function_resources(params = {}) ⇒ Types::CreateServiceFunctionResourcesResponse
Associates resources with a service function.
-
#create_system(params = {}) ⇒ Types::CreateSystemResponse
Creates a system that represents a logical grouping of services.
-
#create_test(params = {}) ⇒ Types::CreateTestResponse
Creates a test for a service by configuring a test template.
-
#create_user_journey(params = {}) ⇒ Types::CreateUserJourneyResponse
Creates a user journey within a system.
-
#delete_assertion(params = {}) ⇒ Types::DeleteAssertionResponse
Deletes a resilience assertion from a service.
-
#delete_input_source(params = {}) ⇒ Types::DeleteInputSourceResponse
Deletes an input source.
-
#delete_policy(params = {}) ⇒ Types::DeletePolicyResponse
Deletes a resilience policy.
-
#delete_service(params = {}) ⇒ Types::DeleteServiceResponse
Deletes a service.
-
#delete_service_function(params = {}) ⇒ Types::DeleteServiceFunctionResponse
Deletes a service function.
-
#delete_service_function_resources(params = {}) ⇒ Types::DeleteServiceFunctionResourcesResponse
Removes resources from a service function.
-
#delete_system(params = {}) ⇒ Types::DeleteSystemResponse
Deletes a system.
-
#delete_test(params = {}) ⇒ Types::DeleteTestResponse
Deletes a test.
-
#delete_test_sources(params = {}) ⇒ Struct
Removes monitoring sources from a test.
-
#delete_user_journey(params = {}) ⇒ Types::DeleteUserJourneyResponse
Deletes a user journey.
-
#get_dependency_insights(params = {}) ⇒ Types::GetDependencyInsightsResponse
Retrieves the dependency insights generated for a service.
-
#get_failure_mode_finding(params = {}) ⇒ Types::GetFailureModeFindingResponse
Retrieves a finding by findingId.
-
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
Retrieves a resilience policy by ARN.
-
#get_service(params = {}) ⇒ Types::GetServiceResponse
Retrieves a service by ARN.
-
#get_system(params = {}) ⇒ Types::GetSystemResponse
Retrieves a system by ARN.
-
#get_test(params = {}) ⇒ Types::GetTestResponse
Retrieves a test by ID.
-
#get_test_run(params = {}) ⇒ Types::GetTestRunResponse
Retrieves a test run by ID, including its status, results, and the configuration snapshotted when the run started.
-
#get_test_template(params = {}) ⇒ Types::GetTestTemplateResponse
Retrieves a resilience test template by ARN, including the parameters it accepts and the fault actions it runs.
-
#get_user_journey(params = {}) ⇒ Types::GetUserJourneyResponse
Retrieves a user journey.
-
#import_app(params = {}) ⇒ Types::ImportAppResponse
Imports a V1 app into the V2 resource model, creating a service with the same name.
-
#import_policy(params = {}) ⇒ Types::ImportPolicyResponse
Imports a V1 policy into V2, mapping RTO/RPO values from V1 scenarios.
-
#list_assertions(params = {}) ⇒ Types::ListAssertionsResponse
Lists resilience assertions for a service.
-
#list_dependencies(params = {}) ⇒ Types::ListDependenciesResponse
Lists dependencies discovered for services.
-
#list_failure_mode_assessments(params = {}) ⇒ Types::ListFailureModeAssessmentsResponse
Lists failure mode assessments.
-
#list_failure_mode_findings(params = {}) ⇒ Types::ListFailureModeFindingsResponse
List findings.
-
#list_input_sources(params = {}) ⇒ Types::ListInputSourcesResponse
Lists input sources for a service.
-
#list_policies(params = {}) ⇒ Types::ListPoliciesResponse
Lists resilience policies.
-
#list_policy_events(params = {}) ⇒ Types::ListPolicyEventsResponse
Lists events for a resilience policy, including services that started or stopped using it, changes to cross-account sharing, and deletion of the policy.
-
#list_reports(params = {}) ⇒ Types::ListReportsResponse
List reports for a service, or all reports owned by the account if serviceArn is not provided.
-
#list_resolved_test_run_target_resources(params = {}) ⇒ Types::ListResolvedTestRunTargetResourcesResponse
Lists the AWS resources that AWS Fault Injection Service (AWS FIS) resolved as targets for a test run.
-
#list_resources(params = {}) ⇒ Types::ListResourcesResponse
List resources.
-
#list_service_events(params = {}) ⇒ Types::ListServiceEventsResponse
Lists events for a service.
-
#list_service_functions(params = {}) ⇒ Types::ListServiceFunctionsResponse
Lists service functions for a service.
-
#list_service_topology_edges(params = {}) ⇒ Types::ListServiceTopologyEdgesResponse
Lists topology edges for a service.
-
#list_services(params = {}) ⇒ Types::ListServicesResponse
Lists services.
-
#list_system_events(params = {}) ⇒ Types::ListSystemEventsResponse
Lists events for a system.
-
#list_systems(params = {}) ⇒ Types::ListSystemsResponse
Lists systems.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for a resource.
-
#list_test_run_dependencies(params = {}) ⇒ Types::ListTestRunDependenciesResponse
Lists the dependencies that a test run blocked.
-
#list_test_run_events(params = {}) ⇒ Types::ListTestRunEventsResponse
Lists the events in a test run's timeline.
-
#list_test_run_source_events(params = {}) ⇒ Types::ListTestRunSourceEventsResponse
Lists the state-change events observed for a test run monitoring source.
-
#list_test_run_sources(params = {}) ⇒ Types::ListTestRunSourcesResponse
Lists the monitoring source snapshots captured for a test run, optionally filtered by type.
-
#list_test_runs(params = {}) ⇒ Types::ListTestRunsResponse
Lists the runs of a test, or all test runs for a service.
-
#list_test_sources(params = {}) ⇒ Types::ListTestSourcesResponse
Lists the monitoring sources attached to a test, optionally filtered by type.
-
#list_test_templates(params = {}) ⇒ Types::ListTestTemplatesResponse
Lists the available resilience test templates.
-
#list_tests(params = {}) ⇒ Types::ListTestsResponse
Lists the tests configured for a service.
-
#list_user_journeys(params = {}) ⇒ Types::ListUserJourneysResponse
Lists user journeys for a system.
-
#put_test_sources(params = {}) ⇒ Struct
Adds or updates the monitoring sources on a test.
-
#start_dependency_insights(params = {}) ⇒ Types::StartDependencyInsightsResponse
Starts generating dependency insights for a service.
-
#start_failure_mode_assessment(params = {}) ⇒ Types::StartFailureModeAssessmentResponse
Starts a failure mode assessment.
-
#start_test_run(params = {}) ⇒ Types::StartTestRunResponse
Starts a run of a test.
-
#stop_test_run(params = {}) ⇒ Types::StopTestRunResponse
Stops an in-progress test run.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
-
#update_assertion(params = {}) ⇒ Types::UpdateAssertionResponse
Updates a resilience assertion.
-
#update_dependency(params = {}) ⇒ Types::UpdateDependencyResponse
Updates a dependency classification.
-
#update_failure_mode_finding(params = {}) ⇒ Types::UpdateFailureModeFindingResponse
Updates an existing finding.
-
#update_policy(params = {}) ⇒ Types::UpdatePolicyResponse
Updates an existing resilience policy.
-
#update_service(params = {}) ⇒ Types::UpdateServiceResponse
Updates an existing service.
-
#update_service_function(params = {}) ⇒ Types::UpdateServiceFunctionResponse
Updates a service function.
-
#update_system(params = {}) ⇒ Types::UpdateSystemResponse
Updates an existing system.
-
#update_test(params = {}) ⇒ Types::UpdateTestResponse
Updates the configuration of an existing test.
-
#update_user_journey(params = {}) ⇒ Types::UpdateUserJourneyResponse
Updates an existing user journey.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
479 480 481 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#create_assertion(params = {}) ⇒ Types::CreateAssertionResponse
Creates a resilience assertion for a service.
524 525 526 527 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 524 def create_assertion(params = {}, = {}) req = build_request(:create_assertion, params) req.send_request() end |
#create_input_source(params = {}) ⇒ Types::CreateInputSourceResponse
Creates an input source for a service.
591 592 593 594 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 591 def create_input_source(params = {}, = {}) req = build_request(:create_input_source, params) req.send_request() end |
#create_policy(params = {}) ⇒ Types::CreatePolicyResponse
Creates a resilience policy that defines availability and disaster recovery requirements.
694 695 696 697 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 694 def create_policy(params = {}, = {}) req = build_request(:create_policy, params) req.send_request() end |
#create_report(params = {}) ⇒ Types::CreateReportResponse
On-demand report creation. Idempotent — duplicate requests with same clientToken return existing result.
743 744 745 746 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 743 def create_report(params = {}, = {}) req = build_request(:create_report, params) req.send_request() end |
#create_service(params = {}) ⇒ Types::CreateServiceResponse
Creates a service.
923 924 925 926 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 923 def create_service(params = {}, = {}) req = build_request(:create_service, params) req.send_request() end |
#create_service_function(params = {}) ⇒ Types::CreateServiceFunctionResponse
Creates a service function within a service.
978 979 980 981 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 978 def create_service_function(params = {}, = {}) req = build_request(:create_service_function, params) req.send_request() end |
#create_service_function_resources(params = {}) ⇒ Types::CreateServiceFunctionResourcesResponse
Associates resources with a service function.
1019 1020 1021 1022 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1019 def create_service_function_resources(params = {}, = {}) req = build_request(:create_service_function_resources, params) req.send_request() end |
#create_system(params = {}) ⇒ Types::CreateSystemResponse
Creates a system that represents a logical grouping of services.
1084 1085 1086 1087 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1084 def create_system(params = {}, = {}) req = build_request(:create_system, params) req.send_request() end |
#create_test(params = {}) ⇒ Types::CreateTestResponse
Creates a test for a service by configuring a test template. Each service has one test per template.
1164 1165 1166 1167 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1164 def create_test(params = {}, = {}) req = build_request(:create_test, params) req.send_request() end |
#create_user_journey(params = {}) ⇒ Types::CreateUserJourneyResponse
Creates a user journey within a system.
1216 1217 1218 1219 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1216 def create_user_journey(params = {}, = {}) req = build_request(:create_user_journey, params) req.send_request() end |
#delete_assertion(params = {}) ⇒ Types::DeleteAssertionResponse
Deletes a resilience assertion from a service.
1248 1249 1250 1251 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1248 def delete_assertion(params = {}, = {}) req = build_request(:delete_assertion, params) req.send_request() end |
#delete_input_source(params = {}) ⇒ Types::DeleteInputSourceResponse
Deletes an input source.
1282 1283 1284 1285 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1282 def delete_input_source(params = {}, = {}) req = build_request(:delete_input_source, params) req.send_request() end |
#delete_policy(params = {}) ⇒ Types::DeletePolicyResponse
Deletes a resilience policy.
1310 1311 1312 1313 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1310 def delete_policy(params = {}, = {}) req = build_request(:delete_policy, params) req.send_request() end |
#delete_service(params = {}) ⇒ Types::DeleteServiceResponse
Deletes a service.
1338 1339 1340 1341 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1338 def delete_service(params = {}, = {}) req = build_request(:delete_service, params) req.send_request() end |
#delete_service_function(params = {}) ⇒ Types::DeleteServiceFunctionResponse
Deletes a service function.
1370 1371 1372 1373 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1370 def delete_service_function(params = {}, = {}) req = build_request(:delete_service_function, params) req.send_request() end |
#delete_service_function_resources(params = {}) ⇒ Types::DeleteServiceFunctionResourcesResponse
Removes resources from a service function.
1411 1412 1413 1414 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1411 def delete_service_function_resources(params = {}, = {}) req = build_request(:delete_service_function_resources, params) req.send_request() end |
#delete_system(params = {}) ⇒ Types::DeleteSystemResponse
Deletes a system.
1439 1440 1441 1442 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1439 def delete_system(params = {}, = {}) req = build_request(:delete_system, params) req.send_request() end |
#delete_test(params = {}) ⇒ Types::DeleteTestResponse
Deletes a test.
1471 1472 1473 1474 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1471 def delete_test(params = {}, = {}) req = build_request(:delete_test, params) req.send_request() end |
#delete_test_sources(params = {}) ⇒ Struct
Removes monitoring sources from a test. The operation is transactional and idempotent — removing a source that is not attached is a no-op.
1511 1512 1513 1514 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1511 def delete_test_sources(params = {}, = {}) req = build_request(:delete_test_sources, params) req.send_request() end |
#delete_user_journey(params = {}) ⇒ Types::DeleteUserJourneyResponse
Deletes a user journey.
1543 1544 1545 1546 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1543 def delete_user_journey(params = {}, = {}) req = build_request(:delete_user_journey, params) req.send_request() end |
#get_dependency_insights(params = {}) ⇒ Types::GetDependencyInsightsResponse
Retrieves the dependency insights generated for a service. The
response reports the current generation status; insights are populated
once generation has completed. If generation failed, the response
includes an error code, whose possible values are listed under the
response's errorCode field, and a message describing the cause. To
use this operation, you must have the
resiliencehub:GetDependencyInsights permission on the service.
1589 1590 1591 1592 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1589 def get_dependency_insights(params = {}, = {}) req = build_request(:get_dependency_insights, params) req.send_request() end |
#get_failure_mode_finding(params = {}) ⇒ Types::GetFailureModeFindingResponse
Retrieves a finding by findingId.
1642 1643 1644 1645 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1642 def get_failure_mode_finding(params = {}, = {}) req = build_request(:get_failure_mode_finding, params) req.send_request() end |
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
Retrieves a resilience policy by ARN.
1688 1689 1690 1691 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1688 def get_policy(params = {}, = {}) req = build_request(:get_policy, params) req.send_request() end |
#get_service(params = {}) ⇒ Types::GetServiceResponse
Retrieves a service by ARN.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- service_assessment_completed
- service_resource_discovery_completed
1796 1797 1798 1799 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1796 def get_service(params = {}, = {}) req = build_request(:get_service, params) req.send_request() end |
#get_system(params = {}) ⇒ Types::GetSystemResponse
Retrieves a system by ARN.
1835 1836 1837 1838 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1835 def get_system(params = {}, = {}) req = build_request(:get_system, params) req.send_request() end |
#get_test(params = {}) ⇒ Types::GetTestResponse
Retrieves a test by ID.
1887 1888 1889 1890 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1887 def get_test(params = {}, = {}) req = build_request(:get_test, params) req.send_request() end |
#get_test_run(params = {}) ⇒ Types::GetTestRunResponse
Retrieves a test run by ID, including its status, results, and the configuration snapshotted when the run started.
1978 1979 1980 1981 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 1978 def get_test_run(params = {}, = {}) req = build_request(:get_test_run, params) req.send_request() end |
#get_test_template(params = {}) ⇒ Types::GetTestTemplateResponse
Retrieves a resilience test template by ARN, including the parameters it accepts and the fault actions it runs.
2020 2021 2022 2023 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 2020 def get_test_template(params = {}, = {}) req = build_request(:get_test_template, params) req.send_request() end |
#get_user_journey(params = {}) ⇒ Types::GetUserJourneyResponse
Retrieves a user journey.
2057 2058 2059 2060 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 2057 def get_user_journey(params = {}, = {}) req = build_request(:get_user_journey, params) req.send_request() end |
#import_app(params = {}) ⇒ Types::ImportAppResponse
Imports a V1 app into the V2 resource model, creating a service with the same name.
2196 2197 2198 2199 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 2196 def import_app(params = {}, = {}) req = build_request(:import_app, params) req.send_request() end |
#import_policy(params = {}) ⇒ Types::ImportPolicyResponse
Imports a V1 policy into V2, mapping RTO/RPO values from V1 scenarios.
2274 2275 2276 2277 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 2274 def import_policy(params = {}, = {}) req = build_request(:import_policy, params) req.send_request() end |
#list_assertions(params = {}) ⇒ Types::ListAssertionsResponse
Lists resilience assertions for a service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2324 2325 2326 2327 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 2324 def list_assertions(params = {}, = {}) req = build_request(:list_assertions, params) req.send_request() end |
#list_dependencies(params = {}) ⇒ Types::ListDependenciesResponse
Lists dependencies discovered for services.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2393 2394 2395 2396 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 2393 def list_dependencies(params = {}, = {}) req = build_request(:list_dependencies, params) req.send_request() end |
#list_failure_mode_assessments(params = {}) ⇒ Types::ListFailureModeAssessmentsResponse
Lists failure mode assessments.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- failure_mode_assessment_success
2476 2477 2478 2479 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 2476 def list_failure_mode_assessments(params = {}, = {}) req = build_request(:list_failure_mode_assessments, params) req.send_request() end |
#list_failure_mode_findings(params = {}) ⇒ Types::ListFailureModeFindingsResponse
List findings.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2538 2539 2540 2541 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 2538 def list_failure_mode_findings(params = {}, = {}) req = build_request(:list_failure_mode_findings, params) req.send_request() end |
#list_input_sources(params = {}) ⇒ Types::ListInputSourcesResponse
Lists input sources for a service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2602 2603 2604 2605 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 2602 def list_input_sources(params = {}, = {}) req = build_request(:list_input_sources, params) req.send_request() end |
#list_policies(params = {}) ⇒ Types::ListPoliciesResponse
Lists resilience policies.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2658 2659 2660 2661 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 2658 def list_policies(params = {}, = {}) req = build_request(:list_policies, params) req.send_request() end |
#list_policy_events(params = {}) ⇒ Types::ListPolicyEventsResponse
Lists events for a resilience policy, including services that started or stopped using it, changes to cross-account sharing, and deletion of the policy.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2728 2729 2730 2731 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 2728 def list_policy_events(params = {}, = {}) req = build_request(:list_policy_events, params) req.send_request() end |
#list_reports(params = {}) ⇒ Types::ListReportsResponse
List reports for a service, or all reports owned by the account if serviceArn is not provided.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- report_succeeded
2792 2793 2794 2795 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 2792 def list_reports(params = {}, = {}) req = build_request(:list_reports, params) req.send_request() end |
#list_resolved_test_run_target_resources(params = {}) ⇒ Types::ListResolvedTestRunTargetResourcesResponse
Lists the AWS resources that AWS Fault Injection Service (AWS FIS) resolved as targets for a test run.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2841 2842 2843 2844 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 2841 def list_resolved_test_run_target_resources(params = {}, = {}) req = build_request(:list_resolved_test_run_target_resources, params) req.send_request() end |
#list_resources(params = {}) ⇒ Types::ListResourcesResponse
List resources.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2911 2912 2913 2914 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 2911 def list_resources(params = {}, = {}) req = build_request(:list_resources, params) req.send_request() end |
#list_service_events(params = {}) ⇒ Types::ListServiceEventsResponse
Lists events for a service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3023 3024 3025 3026 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3023 def list_service_events(params = {}, = {}) req = build_request(:list_service_events, params) req.send_request() end |
#list_service_functions(params = {}) ⇒ Types::ListServiceFunctionsResponse
Lists service functions for a service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3072 3073 3074 3075 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3072 def list_service_functions(params = {}, = {}) req = build_request(:list_service_functions, params) req.send_request() end |
#list_service_topology_edges(params = {}) ⇒ Types::ListServiceTopologyEdgesResponse
Lists topology edges for a service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3121 3122 3123 3124 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3121 def list_service_topology_edges(params = {}, = {}) req = build_request(:list_service_topology_edges, params) req.send_request() end |
#list_services(params = {}) ⇒ Types::ListServicesResponse
Lists services.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3209 3210 3211 3212 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3209 def list_services(params = {}, = {}) req = build_request(:list_services, params) req.send_request() end |
#list_system_events(params = {}) ⇒ Types::ListSystemEventsResponse
Lists events for a system.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3301 3302 3303 3304 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3301 def list_system_events(params = {}, = {}) req = build_request(:list_system_events, params) req.send_request() end |
#list_systems(params = {}) ⇒ Types::ListSystemsResponse
Lists systems.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3350 3351 3352 3353 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3350 def list_systems(params = {}, = {}) req = build_request(:list_systems, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for a resource.
3379 3380 3381 3382 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3379 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_test_run_dependencies(params = {}) ⇒ Types::ListTestRunDependenciesResponse
Lists the dependencies that a test run blocked. Each dependency reflects the discovered classification captured when the run started, so results do not change if a dependency is reclassified after the run.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3435 3436 3437 3438 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3435 def list_test_run_dependencies(params = {}, = {}) req = build_request(:list_test_run_dependencies, params) req.send_request() end |
#list_test_run_events(params = {}) ⇒ Types::ListTestRunEventsResponse
Lists the events in a test run's timeline.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3493 3494 3495 3496 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3493 def list_test_run_events(params = {}, = {}) req = build_request(:list_test_run_events, params) req.send_request() end |
#list_test_run_source_events(params = {}) ⇒ Types::ListTestRunSourceEventsResponse
Lists the state-change events observed for a test run monitoring source. Events are returned for one source per call, in chronological order.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3553 3554 3555 3556 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3553 def list_test_run_source_events(params = {}, = {}) req = build_request(:list_test_run_source_events, params) req.send_request() end |
#list_test_run_sources(params = {}) ⇒ Types::ListTestRunSourcesResponse
Lists the monitoring source snapshots captured for a test run, optionally filtered by type.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3612 3613 3614 3615 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3612 def list_test_run_sources(params = {}, = {}) req = build_request(:list_test_run_sources, params) req.send_request() end |
#list_test_runs(params = {}) ⇒ Types::ListTestRunsResponse
Lists the runs of a test, or all test runs for a service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3664 3665 3666 3667 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3664 def list_test_runs(params = {}, = {}) req = build_request(:list_test_runs, params) req.send_request() end |
#list_test_sources(params = {}) ⇒ Types::ListTestSourcesResponse
Lists the monitoring sources attached to a test, optionally filtered by type.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3723 3724 3725 3726 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3723 def list_test_sources(params = {}, = {}) req = build_request(:list_test_sources, params) req.send_request() end |
#list_test_templates(params = {}) ⇒ Types::ListTestTemplatesResponse
Lists the available resilience test templates. A test template is a pre-configured, AWS recommended test that defines which resilience capability to validate.
3747 3748 3749 3750 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3747 def list_test_templates(params = {}, = {}) req = build_request(:list_test_templates, params) req.send_request() end |
#list_tests(params = {}) ⇒ Types::ListTestsResponse
Lists the tests configured for a service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3793 3794 3795 3796 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3793 def list_tests(params = {}, = {}) req = build_request(:list_tests, params) req.send_request() end |
#list_user_journeys(params = {}) ⇒ Types::ListUserJourneysResponse
Lists user journeys for a system.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3837 3838 3839 3840 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3837 def list_user_journeys(params = {}, = {}) req = build_request(:list_user_journeys, params) req.send_request() end |
#put_test_sources(params = {}) ⇒ Struct
Adds or updates the monitoring sources on a test. The operation is transactional — either every source is written or the call fails and nothing is written.
3878 3879 3880 3881 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3878 def put_test_sources(params = {}, = {}) req = build_request(:put_test_sources, params) req.send_request() end |
#start_dependency_insights(params = {}) ⇒ Types::StartDependencyInsightsResponse
Starts generating dependency insights for a service. Generation runs
asynchronously; the response returns the initial status, and you
retrieve the results with GetDependencyInsights. To use this
operation, you must have the resiliencehub:StartDependencyInsights
permission on the service.
3917 3918 3919 3920 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3917 def start_dependency_insights(params = {}, = {}) req = build_request(:start_dependency_insights, params) req.send_request() end |
#start_failure_mode_assessment(params = {}) ⇒ Types::StartFailureModeAssessmentResponse
Starts a failure mode assessment.
3958 3959 3960 3961 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3958 def start_failure_mode_assessment(params = {}, = {}) req = build_request(:start_failure_mode_assessment, params) req.send_request() end |
#start_test_run(params = {}) ⇒ Types::StartTestRunResponse
Starts a run of a test. Each run scopes to the current resources in the service and produces a pass or fail outcome.
3996 3997 3998 3999 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 3996 def start_test_run(params = {}, = {}) req = build_request(:start_test_run, params) req.send_request() end |
#stop_test_run(params = {}) ⇒ Types::StopTestRunResponse
Stops an in-progress test run.
4030 4031 4032 4033 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 4030 def stop_test_run(params = {}, = {}) req = build_request(:stop_test_run, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to a resource.
4058 4059 4060 4061 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 4058 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
4084 4085 4086 4087 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 4084 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_assertion(params = {}) ⇒ Types::UpdateAssertionResponse
Updates a resilience assertion.
4125 4126 4127 4128 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 4125 def update_assertion(params = {}, = {}) req = build_request(:update_assertion, params) req.send_request() end |
#update_dependency(params = {}) ⇒ Types::UpdateDependencyResponse
Updates a dependency classification.
4177 4178 4179 4180 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 4177 def update_dependency(params = {}, = {}) req = build_request(:update_dependency, params) req.send_request() end |
#update_failure_mode_finding(params = {}) ⇒ Types::UpdateFailureModeFindingResponse
Updates an existing finding.
4238 4239 4240 4241 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 4238 def update_failure_mode_finding(params = {}, = {}) req = build_request(:update_failure_mode_finding, params) req.send_request() end |
#update_policy(params = {}) ⇒ Types::UpdatePolicyResponse
Updates an existing resilience policy.
4321 4322 4323 4324 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 4321 def update_policy(params = {}, = {}) req = build_request(:update_policy, params) req.send_request() end |
#update_service(params = {}) ⇒ Types::UpdateServiceResponse
Updates an existing service.
4483 4484 4485 4486 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 4483 def update_service(params = {}, = {}) req = build_request(:update_service, params) req.send_request() end |
#update_service_function(params = {}) ⇒ Types::UpdateServiceFunctionResponse
Updates a service function.
4535 4536 4537 4538 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 4535 def update_service_function(params = {}, = {}) req = build_request(:update_service_function, params) req.send_request() end |
#update_system(params = {}) ⇒ Types::UpdateSystemResponse
Updates an existing system.
4582 4583 4584 4585 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 4582 def update_system(params = {}, = {}) req = build_request(:update_system, params) req.send_request() end |
#update_test(params = {}) ⇒ Types::UpdateTestResponse
Updates the configuration of an existing test.
4661 4662 4663 4664 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 4661 def update_test(params = {}, = {}) req = build_request(:update_test, params) req.send_request() end |
#update_user_journey(params = {}) ⇒ Types::UpdateUserJourneyResponse
Updates an existing user journey.
4710 4711 4712 4713 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 4710 def update_user_journey(params = {}, = {}) req = build_request(:update_user_journey, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success or :failure from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay and :max_attempts values.
| waiter_name | params | :delay | :max_attempts |
|---|---|---|---|
| failure_mode_assessment_success | #list_failure_mode_assessments | 30 | 5 |
| report_succeeded | #list_reports | 30 | 5 |
| service_assessment_completed | #get_service | 30 | 5 |
| service_resource_discovery_completed | #get_service | 30 | 5 |
4828 4829 4830 4831 4832 |
# File 'gems/aws-sdk-resiliencehubv2/lib/aws-sdk-resiliencehubv2/client.rb', line 4828 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |