aws-sdk-arczonalshift 1.33.0 → 1.37.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -95,7 +95,7 @@ module Aws::ARCZonalShift
95
95
  # class name or an instance of a plugin class.
96
96
  #
97
97
  # @option options [required, Aws::CredentialProvider] :credentials
98
- # Your AWS credentials. This can be an instance of any one of the
98
+ # Your AWS credentials used for authentication. This can be an instance of any one of the
99
99
  # following classes:
100
100
  #
101
101
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
@@ -128,18 +128,23 @@ module Aws::ARCZonalShift
128
128
  # locations will be searched for credentials:
129
129
  #
130
130
  # * `Aws.config[:credentials]`
131
+ #
131
132
  # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
132
133
  # `:account_id` options.
133
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
134
- # ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
134
+ #
135
+ # * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
136
+ # `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
137
+ #
135
138
  # * `~/.aws/credentials`
139
+ #
136
140
  # * `~/.aws/config`
141
+ #
137
142
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
138
143
  # are very aggressive. Construct and pass an instance of
139
144
  # `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
140
145
  # enable retries and extended timeouts. Instance profile credential
141
- # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
142
- # to true.
146
+ # fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
147
+ # to `true`.
143
148
  #
144
149
  # @option options [required, String] :region
145
150
  # The AWS region to connect to. The configured `:region` is
@@ -167,6 +172,11 @@ module Aws::ARCZonalShift
167
172
  # When false, the request will raise a `RetryCapacityNotAvailableError` and will
168
173
  # not retry instead of sleeping.
169
174
  #
175
+ # @option options [Array<String>] :auth_scheme_preference
176
+ # A list of preferred authentication schemes to use when making a request. Supported values are:
177
+ # `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
178
+ # shared config as `auth_scheme_preference`, the value should be a comma-separated list.
179
+ #
170
180
  # @option options [Boolean] :client_side_monitoring (false)
171
181
  # When `true`, client-side metrics will be collected for all API requests from
172
182
  # this client.
@@ -253,8 +263,8 @@ module Aws::ARCZonalShift
253
263
  # 4 times. Used in `standard` and `adaptive` retry modes.
254
264
  #
255
265
  # @option options [String] :profile ("default")
256
- # Used when loading credentials from the shared credentials file
257
- # at HOME/.aws/credentials. When not specified, 'default' is used.
266
+ # Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
267
+ # When not specified, 'default' is used.
258
268
  #
259
269
  # @option options [String] :request_checksum_calculation ("when_supported")
260
270
  # Determines when a checksum will be calculated for request payloads. Values are:
@@ -367,7 +377,7 @@ module Aws::ARCZonalShift
367
377
  # `Aws::Telemetry::OTelProvider` for telemetry provider.
368
378
  #
369
379
  # @option options [Aws::TokenProvider] :token_provider
370
- # A Bearer Token Provider. This can be an instance of any one of the
380
+ # Your Bearer token used for authentication. This can be an instance of any one of the
371
381
  # following classes:
372
382
  #
373
383
  # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
@@ -469,8 +479,50 @@ module Aws::ARCZonalShift
469
479
 
470
480
  # @!group API Operations
471
481
 
472
- # Cancel a zonal shift in Amazon Route 53 Application Recovery
473
- # Controller. To cancel the zonal shift, specify the zonal shift ID.
482
+ # Cancel an in-progress practice run zonal shift in Amazon Application
483
+ # Recovery Controller.
484
+ #
485
+ # @option params [required, String] :zonal_shift_id
486
+ # The identifier of a practice run zonal shift in Amazon Application
487
+ # Recovery Controller that you want to cancel.
488
+ #
489
+ # @return [Types::CancelPracticeRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
490
+ #
491
+ # * {Types::CancelPracticeRunResponse#zonal_shift_id #zonal_shift_id} => String
492
+ # * {Types::CancelPracticeRunResponse#resource_identifier #resource_identifier} => String
493
+ # * {Types::CancelPracticeRunResponse#away_from #away_from} => String
494
+ # * {Types::CancelPracticeRunResponse#expiry_time #expiry_time} => Time
495
+ # * {Types::CancelPracticeRunResponse#start_time #start_time} => Time
496
+ # * {Types::CancelPracticeRunResponse#status #status} => String
497
+ # * {Types::CancelPracticeRunResponse#comment #comment} => String
498
+ #
499
+ # @example Request syntax with placeholder values
500
+ #
501
+ # resp = client.cancel_practice_run({
502
+ # zonal_shift_id: "ZonalShiftId", # required
503
+ # })
504
+ #
505
+ # @example Response structure
506
+ #
507
+ # resp.zonal_shift_id #=> String
508
+ # resp.resource_identifier #=> String
509
+ # resp.away_from #=> String
510
+ # resp.expiry_time #=> Time
511
+ # resp.start_time #=> Time
512
+ # resp.status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
513
+ # resp.comment #=> String
514
+ #
515
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CancelPracticeRun AWS API Documentation
516
+ #
517
+ # @overload cancel_practice_run(params = {})
518
+ # @param [Hash] params ({})
519
+ def cancel_practice_run(params = {}, options = {})
520
+ req = build_request(:cancel_practice_run, params)
521
+ req.send_request(options)
522
+ end
523
+
524
+ # Cancel a zonal shift in Amazon Application Recovery Controller. To
525
+ # cancel the zonal shift, specify the zonal shift ID.
474
526
  #
475
527
  # A zonal shift can be one that you've started for a resource in your
476
528
  # Amazon Web Services account in an Amazon Web Services Region, or it
@@ -481,13 +533,13 @@ module Aws::ARCZonalShift
481
533
  #
482
534
  # @return [Types::ZonalShift] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
483
535
  #
536
+ # * {Types::ZonalShift#zonal_shift_id #zonal_shift_id} => String
537
+ # * {Types::ZonalShift#resource_identifier #resource_identifier} => String
484
538
  # * {Types::ZonalShift#away_from #away_from} => String
485
- # * {Types::ZonalShift#comment #comment} => String
486
539
  # * {Types::ZonalShift#expiry_time #expiry_time} => Time
487
- # * {Types::ZonalShift#resource_identifier #resource_identifier} => String
488
540
  # * {Types::ZonalShift#start_time #start_time} => Time
489
541
  # * {Types::ZonalShift#status #status} => String
490
- # * {Types::ZonalShift#zonal_shift_id #zonal_shift_id} => String
542
+ # * {Types::ZonalShift#comment #comment} => String
491
543
  #
492
544
  # @example Request syntax with placeholder values
493
545
  #
@@ -497,13 +549,13 @@ module Aws::ARCZonalShift
497
549
  #
498
550
  # @example Response structure
499
551
  #
552
+ # resp.zonal_shift_id #=> String
553
+ # resp.resource_identifier #=> String
500
554
  # resp.away_from #=> String
501
- # resp.comment #=> String
502
555
  # resp.expiry_time #=> Time
503
- # resp.resource_identifier #=> String
504
556
  # resp.start_time #=> Time
505
557
  # resp.status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
506
- # resp.zonal_shift_id #=> String
558
+ # resp.comment #=> String
507
559
  #
508
560
  # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CancelZonalShift AWS API Documentation
509
561
  #
@@ -528,24 +580,35 @@ module Aws::ARCZonalShift
528
580
  # Availability Zone during an autoshift is safe for your application.
529
581
  #
530
582
  # For more information, see [ Considerations when you configure zonal
531
- # autoshift][1] in the Amazon Route 53 Application Recovery Controller
532
- # Developer Guide.
583
+ # autoshift][1] in the Amazon Application Recovery Controller Developer
584
+ # Guide.
533
585
  #
534
586
  #
535
587
  #
536
588
  # [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html
537
589
  #
538
- # @option params [Array<String>] :blocked_dates
539
- # Optionally, you can block ARC from starting practice runs for a
540
- # resource on specific calendar dates.
590
+ # @option params [required, String] :resource_identifier
591
+ # The identifier of the resource that Amazon Web Services shifts traffic
592
+ # for with a practice run zonal shift. The identifier is the Amazon
593
+ # Resource Name (ARN) for the resource.
594
+ #
595
+ # Amazon Application Recovery Controller currently supports enabling the
596
+ # following resources for zonal shift and zonal autoshift:
597
+ #
598
+ # * [Amazon EC2 Auto Scaling groups][1]
599
+ #
600
+ # * [Amazon Elastic Kubernetes Service][2]
601
+ #
602
+ # * [Application Load Balancer][3]
603
+ #
604
+ # * [Network Load Balancer][4]
541
605
  #
542
- # The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you
543
- # specify dates, that dates and times for practice runs are in UTC.
544
- # Separate multiple blocked dates with spaces.
545
606
  #
546
- # For example, if you have an application update scheduled to launch on
547
- # May 1, 2024, and you don't want practice runs to shift traffic away
548
- # at that time, you could set a blocked date for `2024-05-01`.
607
+ #
608
+ # [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html
609
+ # [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html
610
+ # [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html
611
+ # [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html
549
612
  #
550
613
  # @option params [Array<String>] :blocked_windows
551
614
  # Optionally, you can block ARC from starting practice runs for specific
@@ -562,6 +625,18 @@ module Aws::ARCZonalShift
562
625
  # times as blocked windows, for example: `MON-20:30-21:30
563
626
  # WED-20:30-21:30 FRI-20:30-21:30`.
564
627
  #
628
+ # @option params [Array<String>] :blocked_dates
629
+ # Optionally, you can block ARC from starting practice runs for a
630
+ # resource on specific calendar dates.
631
+ #
632
+ # The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you
633
+ # specify dates, that dates and times for practice runs are in UTC.
634
+ # Separate multiple blocked dates with spaces.
635
+ #
636
+ # For example, if you have an application update scheduled to launch on
637
+ # May 1, 2024, and you don't want practice runs to shift traffic away
638
+ # at that time, you could set a blocked date for `2024-05-01`.
639
+ #
565
640
  # @option params [Array<Types::ControlCondition>] :blocking_alarms
566
641
  # An Amazon CloudWatch alarm that you can specify for zonal autoshift
567
642
  # practice runs. This alarm blocks ARC from starting practice run zonal
@@ -580,56 +655,48 @@ module Aws::ARCZonalShift
580
655
  # the zonal shift, to let traffic for the resource return to the
581
656
  # Availability Zone.
582
657
  #
583
- # @option params [required, String] :resource_identifier
584
- # The identifier of the resource that Amazon Web Services shifts traffic
585
- # for with a practice run zonal shift. The identifier is the Amazon
586
- # Resource Name (ARN) for the resource.
587
- #
588
- # At this time, supported resources are Network Load Balancers and
589
- # Application Load Balancers with cross-zone load balancing turned off.
590
- #
591
658
  # @return [Types::CreatePracticeRunConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
592
659
  #
593
660
  # * {Types::CreatePracticeRunConfigurationResponse#arn #arn} => String
594
661
  # * {Types::CreatePracticeRunConfigurationResponse#name #name} => String
595
- # * {Types::CreatePracticeRunConfigurationResponse#practice_run_configuration #practice_run_configuration} => Types::PracticeRunConfiguration
596
662
  # * {Types::CreatePracticeRunConfigurationResponse#zonal_autoshift_status #zonal_autoshift_status} => String
663
+ # * {Types::CreatePracticeRunConfigurationResponse#practice_run_configuration #practice_run_configuration} => Types::PracticeRunConfiguration
597
664
  #
598
665
  # @example Request syntax with placeholder values
599
666
  #
600
667
  # resp = client.create_practice_run_configuration({
601
- # blocked_dates: ["BlockedDate"],
668
+ # resource_identifier: "ResourceIdentifier", # required
602
669
  # blocked_windows: ["BlockedWindow"],
670
+ # blocked_dates: ["BlockedDate"],
603
671
  # blocking_alarms: [
604
672
  # {
605
- # alarm_identifier: "MetricIdentifier", # required
606
673
  # type: "CLOUDWATCH", # required, accepts CLOUDWATCH
674
+ # alarm_identifier: "MetricIdentifier", # required
607
675
  # },
608
676
  # ],
609
677
  # outcome_alarms: [ # required
610
678
  # {
611
- # alarm_identifier: "MetricIdentifier", # required
612
679
  # type: "CLOUDWATCH", # required, accepts CLOUDWATCH
680
+ # alarm_identifier: "MetricIdentifier", # required
613
681
  # },
614
682
  # ],
615
- # resource_identifier: "ResourceIdentifier", # required
616
683
  # })
617
684
  #
618
685
  # @example Response structure
619
686
  #
620
687
  # resp.arn #=> String
621
688
  # resp.name #=> String
622
- # resp.practice_run_configuration.blocked_dates #=> Array
623
- # resp.practice_run_configuration.blocked_dates[0] #=> String
624
- # resp.practice_run_configuration.blocked_windows #=> Array
625
- # resp.practice_run_configuration.blocked_windows[0] #=> String
689
+ # resp.zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
626
690
  # resp.practice_run_configuration.blocking_alarms #=> Array
627
- # resp.practice_run_configuration.blocking_alarms[0].alarm_identifier #=> String
628
691
  # resp.practice_run_configuration.blocking_alarms[0].type #=> String, one of "CLOUDWATCH"
692
+ # resp.practice_run_configuration.blocking_alarms[0].alarm_identifier #=> String
629
693
  # resp.practice_run_configuration.outcome_alarms #=> Array
630
- # resp.practice_run_configuration.outcome_alarms[0].alarm_identifier #=> String
631
694
  # resp.practice_run_configuration.outcome_alarms[0].type #=> String, one of "CLOUDWATCH"
632
- # resp.zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
695
+ # resp.practice_run_configuration.outcome_alarms[0].alarm_identifier #=> String
696
+ # resp.practice_run_configuration.blocked_windows #=> Array
697
+ # resp.practice_run_configuration.blocked_windows[0] #=> String
698
+ # resp.practice_run_configuration.blocked_dates #=> Array
699
+ # resp.practice_run_configuration.blocked_dates[0] #=> String
633
700
  #
634
701
  # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CreatePracticeRunConfiguration AWS API Documentation
635
702
  #
@@ -702,28 +769,43 @@ module Aws::ARCZonalShift
702
769
  end
703
770
 
704
771
  # Get information about a resource that's been registered for zonal
705
- # shifts with Amazon Route 53 Application Recovery Controller in this
706
- # Amazon Web Services Region. Resources that are registered for zonal
707
- # shifts are managed resources in ARC. You can start zonal shifts and
708
- # configure zonal autoshift for managed resources.
772
+ # shifts with Amazon Application Recovery Controller in this Amazon Web
773
+ # Services Region. Resources that are registered for zonal shifts are
774
+ # managed resources in ARC. You can start zonal shifts and configure
775
+ # zonal autoshift for managed resources.
709
776
  #
710
777
  # @option params [required, String] :resource_identifier
711
778
  # The identifier for the resource that Amazon Web Services shifts
712
779
  # traffic for. The identifier is the Amazon Resource Name (ARN) for the
713
780
  # resource.
714
781
  #
715
- # At this time, supported resources are Network Load Balancers and
716
- # Application Load Balancers with cross-zone load balancing turned off.
782
+ # Amazon Application Recovery Controller currently supports enabling the
783
+ # following resources for zonal shift and zonal autoshift:
784
+ #
785
+ # * [Amazon EC2 Auto Scaling groups][1]
786
+ #
787
+ # * [Amazon Elastic Kubernetes Service][2]
788
+ #
789
+ # * [Application Load Balancer][3]
790
+ #
791
+ # * [Network Load Balancer][4]
792
+ #
793
+ #
794
+ #
795
+ # [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html
796
+ # [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html
797
+ # [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html
798
+ # [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html
717
799
  #
718
800
  # @return [Types::GetManagedResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
719
801
  #
720
- # * {Types::GetManagedResourceResponse#applied_weights #applied_weights} => Hash&lt;String,Float&gt;
721
802
  # * {Types::GetManagedResourceResponse#arn #arn} => String
722
- # * {Types::GetManagedResourceResponse#autoshifts #autoshifts} => Array&lt;Types::AutoshiftInResource&gt;
723
803
  # * {Types::GetManagedResourceResponse#name #name} => String
804
+ # * {Types::GetManagedResourceResponse#applied_weights #applied_weights} => Hash&lt;String,Float&gt;
805
+ # * {Types::GetManagedResourceResponse#zonal_shifts #zonal_shifts} => Array&lt;Types::ZonalShiftInResource&gt;
806
+ # * {Types::GetManagedResourceResponse#autoshifts #autoshifts} => Array&lt;Types::AutoshiftInResource&gt;
724
807
  # * {Types::GetManagedResourceResponse#practice_run_configuration #practice_run_configuration} => Types::PracticeRunConfiguration
725
808
  # * {Types::GetManagedResourceResponse#zonal_autoshift_status #zonal_autoshift_status} => String
726
- # * {Types::GetManagedResourceResponse#zonal_shifts #zonal_shifts} => Array&lt;Types::ZonalShiftInResource&gt;
727
809
  #
728
810
  # @example Request syntax with placeholder values
729
811
  #
@@ -733,35 +815,35 @@ module Aws::ARCZonalShift
733
815
  #
734
816
  # @example Response structure
735
817
  #
818
+ # resp.arn #=> String
819
+ # resp.name #=> String
736
820
  # resp.applied_weights #=> Hash
737
821
  # resp.applied_weights["AvailabilityZone"] #=> Float
738
- # resp.arn #=> String
822
+ # resp.zonal_shifts #=> Array
823
+ # resp.zonal_shifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
824
+ # resp.zonal_shifts[0].zonal_shift_id #=> String
825
+ # resp.zonal_shifts[0].resource_identifier #=> String
826
+ # resp.zonal_shifts[0].away_from #=> String
827
+ # resp.zonal_shifts[0].expiry_time #=> Time
828
+ # resp.zonal_shifts[0].start_time #=> Time
829
+ # resp.zonal_shifts[0].comment #=> String
830
+ # resp.zonal_shifts[0].shift_type #=> String, one of "ZONAL_SHIFT", "PRACTICE_RUN", "FIS_EXPERIMENT", "ZONAL_AUTOSHIFT"
831
+ # resp.zonal_shifts[0].practice_run_outcome #=> String, one of "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED", "CAPACITY_CHECK_FAILED"
739
832
  # resp.autoshifts #=> Array
740
833
  # resp.autoshifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
741
834
  # resp.autoshifts[0].away_from #=> String
742
835
  # resp.autoshifts[0].start_time #=> Time
743
- # resp.name #=> String
744
- # resp.practice_run_configuration.blocked_dates #=> Array
745
- # resp.practice_run_configuration.blocked_dates[0] #=> String
746
- # resp.practice_run_configuration.blocked_windows #=> Array
747
- # resp.practice_run_configuration.blocked_windows[0] #=> String
748
836
  # resp.practice_run_configuration.blocking_alarms #=> Array
749
- # resp.practice_run_configuration.blocking_alarms[0].alarm_identifier #=> String
750
837
  # resp.practice_run_configuration.blocking_alarms[0].type #=> String, one of "CLOUDWATCH"
838
+ # resp.practice_run_configuration.blocking_alarms[0].alarm_identifier #=> String
751
839
  # resp.practice_run_configuration.outcome_alarms #=> Array
752
- # resp.practice_run_configuration.outcome_alarms[0].alarm_identifier #=> String
753
840
  # resp.practice_run_configuration.outcome_alarms[0].type #=> String, one of "CLOUDWATCH"
841
+ # resp.practice_run_configuration.outcome_alarms[0].alarm_identifier #=> String
842
+ # resp.practice_run_configuration.blocked_windows #=> Array
843
+ # resp.practice_run_configuration.blocked_windows[0] #=> String
844
+ # resp.practice_run_configuration.blocked_dates #=> Array
845
+ # resp.practice_run_configuration.blocked_dates[0] #=> String
754
846
  # resp.zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
755
- # resp.zonal_shifts #=> Array
756
- # resp.zonal_shifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
757
- # resp.zonal_shifts[0].away_from #=> String
758
- # resp.zonal_shifts[0].comment #=> String
759
- # resp.zonal_shifts[0].expiry_time #=> Time
760
- # resp.zonal_shifts[0].practice_run_outcome #=> String, one of "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED"
761
- # resp.zonal_shifts[0].resource_identifier #=> String
762
- # resp.zonal_shifts[0].shift_type #=> String, one of "ZONAL_SHIFT", "PRACTICE_RUN", "FIS_EXPERIMENT", "ZONAL_AUTOSHIFT"
763
- # resp.zonal_shifts[0].start_time #=> Time
764
- # resp.zonal_shifts[0].zonal_shift_id #=> String
765
847
  #
766
848
  # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/GetManagedResource AWS API Documentation
767
849
  #
@@ -776,9 +858,6 @@ module Aws::ARCZonalShift
776
858
  # the call returns only `ACTIVE` autoshifts. Optionally, you can specify
777
859
  # the `status` parameter to return `COMPLETED` autoshifts.
778
860
  #
779
- # @option params [Integer] :max_results
780
- # The number of objects that you want to return with this call.
781
- #
782
861
  # @option params [String] :next_token
783
862
  # Specifies that you want to receive the next page of results. Valid
784
863
  # only if you received a `nextToken` response in the previous request.
@@ -789,6 +868,9 @@ module Aws::ARCZonalShift
789
868
  # @option params [String] :status
790
869
  # The status of the autoshift.
791
870
  #
871
+ # @option params [Integer] :max_results
872
+ # The number of objects that you want to return with this call.
873
+ #
792
874
  # @return [Types::ListAutoshiftsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
793
875
  #
794
876
  # * {Types::ListAutoshiftsResponse#items #items} => Array&lt;Types::AutoshiftSummary&gt;
@@ -799,9 +881,9 @@ module Aws::ARCZonalShift
799
881
  # @example Request syntax with placeholder values
800
882
  #
801
883
  # resp = client.list_autoshifts({
802
- # max_results: 1,
803
884
  # next_token: "String",
804
885
  # status: "ACTIVE", # accepts ACTIVE, COMPLETED
886
+ # max_results: 1,
805
887
  # })
806
888
  #
807
889
  # @example Response structure
@@ -824,14 +906,11 @@ module Aws::ARCZonalShift
824
906
 
825
907
  # Lists all the resources in your Amazon Web Services account in this
826
908
  # Amazon Web Services Region that are managed for zonal shifts in Amazon
827
- # Route 53 Application Recovery Controller, and information about them.
828
- # The information includes the zonal autoshift status for the resource,
829
- # as well as the Amazon Resource Name (ARN), the Availability Zones that
909
+ # Application Recovery Controller, and information about them. The
910
+ # information includes the zonal autoshift status for the resource, as
911
+ # well as the Amazon Resource Name (ARN), the Availability Zones that
830
912
  # each resource is deployed in, and the resource name.
831
913
  #
832
- # @option params [Integer] :max_results
833
- # The number of objects that you want to return with this call.
834
- #
835
914
  # @option params [String] :next_token
836
915
  # Specifies that you want to receive the next page of results. Valid
837
916
  # only if you received a `nextToken` response in the previous request.
@@ -839,6 +918,9 @@ module Aws::ARCZonalShift
839
918
  # parameter to the value provided by the previous call's `nextToken`
840
919
  # response to request the next page of results.
841
920
  #
921
+ # @option params [Integer] :max_results
922
+ # The number of objects that you want to return with this call.
923
+ #
842
924
  # @return [Types::ListManagedResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
843
925
  #
844
926
  # * {Types::ListManagedResourcesResponse#items #items} => Array&lt;Types::ManagedResourceSummary&gt;
@@ -849,35 +931,35 @@ module Aws::ARCZonalShift
849
931
  # @example Request syntax with placeholder values
850
932
  #
851
933
  # resp = client.list_managed_resources({
852
- # max_results: 1,
853
934
  # next_token: "String",
935
+ # max_results: 1,
854
936
  # })
855
937
  #
856
938
  # @example Response structure
857
939
  #
858
940
  # resp.items #=> Array
859
- # resp.items[0].applied_weights #=> Hash
860
- # resp.items[0].applied_weights["AvailabilityZone"] #=> Float
861
941
  # resp.items[0].arn #=> String
862
- # resp.items[0].autoshifts #=> Array
863
- # resp.items[0].autoshifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
864
- # resp.items[0].autoshifts[0].away_from #=> String
865
- # resp.items[0].autoshifts[0].start_time #=> Time
942
+ # resp.items[0].name #=> String
866
943
  # resp.items[0].availability_zones #=> Array
867
944
  # resp.items[0].availability_zones[0] #=> String
868
- # resp.items[0].name #=> String
869
- # resp.items[0].practice_run_status #=> String, one of "ENABLED", "DISABLED"
870
- # resp.items[0].zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
945
+ # resp.items[0].applied_weights #=> Hash
946
+ # resp.items[0].applied_weights["AvailabilityZone"] #=> Float
871
947
  # resp.items[0].zonal_shifts #=> Array
872
948
  # resp.items[0].zonal_shifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
949
+ # resp.items[0].zonal_shifts[0].zonal_shift_id #=> String
950
+ # resp.items[0].zonal_shifts[0].resource_identifier #=> String
873
951
  # resp.items[0].zonal_shifts[0].away_from #=> String
874
- # resp.items[0].zonal_shifts[0].comment #=> String
875
952
  # resp.items[0].zonal_shifts[0].expiry_time #=> Time
876
- # resp.items[0].zonal_shifts[0].practice_run_outcome #=> String, one of "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED"
877
- # resp.items[0].zonal_shifts[0].resource_identifier #=> String
878
- # resp.items[0].zonal_shifts[0].shift_type #=> String, one of "ZONAL_SHIFT", "PRACTICE_RUN", "FIS_EXPERIMENT", "ZONAL_AUTOSHIFT"
879
953
  # resp.items[0].zonal_shifts[0].start_time #=> Time
880
- # resp.items[0].zonal_shifts[0].zonal_shift_id #=> String
954
+ # resp.items[0].zonal_shifts[0].comment #=> String
955
+ # resp.items[0].zonal_shifts[0].shift_type #=> String, one of "ZONAL_SHIFT", "PRACTICE_RUN", "FIS_EXPERIMENT", "ZONAL_AUTOSHIFT"
956
+ # resp.items[0].zonal_shifts[0].practice_run_outcome #=> String, one of "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED", "CAPACITY_CHECK_FAILED"
957
+ # resp.items[0].autoshifts #=> Array
958
+ # resp.items[0].autoshifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
959
+ # resp.items[0].autoshifts[0].away_from #=> String
960
+ # resp.items[0].autoshifts[0].start_time #=> Time
961
+ # resp.items[0].zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
962
+ # resp.items[0].practice_run_status #=> String, one of "ENABLED", "DISABLED"
881
963
  # resp.next_token #=> String
882
964
  #
883
965
  # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListManagedResources AWS API Documentation
@@ -889,12 +971,18 @@ module Aws::ARCZonalShift
889
971
  req.send_request(options)
890
972
  end
891
973
 
892
- # Lists all active and completed zonal shifts in Amazon Route 53
893
- # Application Recovery Controller in your Amazon Web Services account in
894
- # this Amazon Web Services Region.
974
+ # Lists all active and completed zonal shifts in Amazon Application
975
+ # Recovery Controller in your Amazon Web Services account in this Amazon
976
+ # Web Services Region. `ListZonalShifts` returns customer-initiated
977
+ # zonal shifts, as well as practice run zonal shifts that ARC started on
978
+ # your behalf for zonal autoshift.
895
979
  #
896
- # @option params [Integer] :max_results
897
- # The number of objects that you want to return with this call.
980
+ # For more information about listing autoshifts, see
981
+ # ["&gt;ListAutoshifts][1].
982
+ #
983
+ #
984
+ #
985
+ # [1]: https://docs.aws.amazon.com/arc-zonal-shift/latest/api/API_ListAutoshifts.html
898
986
  #
899
987
  # @option params [String] :next_token
900
988
  # Specifies that you want to receive the next page of results. Valid
@@ -903,23 +991,26 @@ module Aws::ARCZonalShift
903
991
  # parameter to the value provided by the previous call's `nextToken`
904
992
  # response to request the next page of results.
905
993
  #
906
- # @option params [String] :resource_identifier
907
- # The identifier for the resource that you want to list zonal shifts
908
- # for. The identifier is the Amazon Resource Name (ARN) for the
909
- # resource.
910
- #
911
994
  # @option params [String] :status
912
995
  # A status for a zonal shift.
913
996
  #
914
997
  # The `Status` for a zonal shift can have one of the following values:
915
998
  #
916
- # * **ACTIVE**: The zonal shift has been started and active.
999
+ # * **ACTIVE**: The zonal shift has been started and is active.
917
1000
  #
918
1001
  # * **EXPIRED**: The zonal shift has expired (the expiry time was
919
1002
  # exceeded).
920
1003
  #
921
1004
  # * **CANCELED**: The zonal shift was canceled.
922
1005
  #
1006
+ # @option params [Integer] :max_results
1007
+ # The number of objects that you want to return with this call.
1008
+ #
1009
+ # @option params [String] :resource_identifier
1010
+ # The identifier for the resource that you want to list zonal shifts
1011
+ # for. The identifier is the Amazon Resource Name (ARN) for the
1012
+ # resource.
1013
+ #
923
1014
  # @return [Types::ListZonalShiftsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
924
1015
  #
925
1016
  # * {Types::ListZonalShiftsResponse#items #items} => Array&lt;Types::ZonalShiftSummary&gt;
@@ -930,24 +1021,24 @@ module Aws::ARCZonalShift
930
1021
  # @example Request syntax with placeholder values
931
1022
  #
932
1023
  # resp = client.list_zonal_shifts({
933
- # max_results: 1,
934
1024
  # next_token: "String",
935
- # resource_identifier: "ResourceIdentifier",
936
1025
  # status: "ACTIVE", # accepts ACTIVE, EXPIRED, CANCELED
1026
+ # max_results: 1,
1027
+ # resource_identifier: "ResourceIdentifier",
937
1028
  # })
938
1029
  #
939
1030
  # @example Response structure
940
1031
  #
941
1032
  # resp.items #=> Array
1033
+ # resp.items[0].zonal_shift_id #=> String
1034
+ # resp.items[0].resource_identifier #=> String
942
1035
  # resp.items[0].away_from #=> String
943
- # resp.items[0].comment #=> String
944
1036
  # resp.items[0].expiry_time #=> Time
945
- # resp.items[0].practice_run_outcome #=> String, one of "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED"
946
- # resp.items[0].resource_identifier #=> String
947
- # resp.items[0].shift_type #=> String, one of "ZONAL_SHIFT", "PRACTICE_RUN", "FIS_EXPERIMENT", "ZONAL_AUTOSHIFT"
948
1037
  # resp.items[0].start_time #=> Time
949
1038
  # resp.items[0].status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
950
- # resp.items[0].zonal_shift_id #=> String
1039
+ # resp.items[0].comment #=> String
1040
+ # resp.items[0].shift_type #=> String, one of "ZONAL_SHIFT", "PRACTICE_RUN", "FIS_EXPERIMENT", "ZONAL_AUTOSHIFT"
1041
+ # resp.items[0].practice_run_outcome #=> String, one of "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED", "CAPACITY_CHECK_FAILED"
951
1042
  # resp.next_token #=> String
952
1043
  #
953
1044
  # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListZonalShifts AWS API Documentation
@@ -959,6 +1050,78 @@ module Aws::ARCZonalShift
959
1050
  req.send_request(options)
960
1051
  end
961
1052
 
1053
+ # Start an on-demand practice run zonal shift in Amazon Application
1054
+ # Recovery Controller. With zonal autoshift enabled, you can start an
1055
+ # on-demand practice run to verify preparedness at any time. Amazon Web
1056
+ # Services also runs automated practice runs about weekly when you have
1057
+ # enabled zonal autoshift.
1058
+ #
1059
+ # For more information, see [ Considerations when you configure zonal
1060
+ # autoshift][1] in the Amazon Application Recovery Controller Developer
1061
+ # Guide.
1062
+ #
1063
+ #
1064
+ #
1065
+ # [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html
1066
+ #
1067
+ # @option params [required, String] :resource_identifier
1068
+ # The identifier for the resource that you want to start a practice run
1069
+ # zonal shift for. The identifier is the Amazon Resource Name (ARN) for
1070
+ # the resource.
1071
+ #
1072
+ # @option params [required, String] :away_from
1073
+ # The Availability Zone (for example, `use1-az1`) that traffic is
1074
+ # shifted away from for the resource that you specify for the practice
1075
+ # run.
1076
+ #
1077
+ # @option params [required, String] :comment
1078
+ # The initial comment that you enter about the practice run. Be aware
1079
+ # that this comment can be overwritten by Amazon Web Services if the
1080
+ # automatic check for balanced capacity fails. For more information, see
1081
+ # [ Capacity checks for practice runs][1] in the Amazon Application
1082
+ # Recovery Controller Developer Guide.
1083
+ #
1084
+ #
1085
+ #
1086
+ # [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.capacity-check.html
1087
+ #
1088
+ # @return [Types::StartPracticeRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1089
+ #
1090
+ # * {Types::StartPracticeRunResponse#zonal_shift_id #zonal_shift_id} => String
1091
+ # * {Types::StartPracticeRunResponse#resource_identifier #resource_identifier} => String
1092
+ # * {Types::StartPracticeRunResponse#away_from #away_from} => String
1093
+ # * {Types::StartPracticeRunResponse#expiry_time #expiry_time} => Time
1094
+ # * {Types::StartPracticeRunResponse#start_time #start_time} => Time
1095
+ # * {Types::StartPracticeRunResponse#status #status} => String
1096
+ # * {Types::StartPracticeRunResponse#comment #comment} => String
1097
+ #
1098
+ # @example Request syntax with placeholder values
1099
+ #
1100
+ # resp = client.start_practice_run({
1101
+ # resource_identifier: "ResourceIdentifier", # required
1102
+ # away_from: "AvailabilityZone", # required
1103
+ # comment: "ZonalShiftComment", # required
1104
+ # })
1105
+ #
1106
+ # @example Response structure
1107
+ #
1108
+ # resp.zonal_shift_id #=> String
1109
+ # resp.resource_identifier #=> String
1110
+ # resp.away_from #=> String
1111
+ # resp.expiry_time #=> Time
1112
+ # resp.start_time #=> Time
1113
+ # resp.status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
1114
+ # resp.comment #=> String
1115
+ #
1116
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/StartPracticeRun AWS API Documentation
1117
+ #
1118
+ # @overload start_practice_run(params = {})
1119
+ # @param [Hash] params ({})
1120
+ def start_practice_run(params = {}, options = {})
1121
+ req = build_request(:start_practice_run, params)
1122
+ req.send_request(options)
1123
+ end
1124
+
962
1125
  # You start a zonal shift to temporarily move load balancer traffic away
963
1126
  # from an Availability Zone in an Amazon Web Services Region, to help
964
1127
  # your application recover immediately, for example, from a developer's
@@ -968,9 +1131,16 @@ module Aws::ARCZonalShift
968
1131
  # an Amazon Web Services Region. Resources are automatically registered
969
1132
  # with ARC by Amazon Web Services services.
970
1133
  #
971
- # At this time, you can only start a zonal shift for Network Load
972
- # Balancers and Application Load Balancers with cross-zone load
973
- # balancing turned off.
1134
+ # Amazon Application Recovery Controller currently supports enabling the
1135
+ # following resources for zonal shift and zonal autoshift:
1136
+ #
1137
+ # * [Amazon EC2 Auto Scaling groups][1]
1138
+ #
1139
+ # * [Amazon Elastic Kubernetes Service][2]
1140
+ #
1141
+ # * [Application Load Balancer][3]
1142
+ #
1143
+ # * [Network Load Balancer][4]
974
1144
  #
975
1145
  # When you start a zonal shift, traffic for the resource is no longer
976
1146
  # routed to the Availability Zone. The zonal shift is created
@@ -978,12 +1148,39 @@ module Aws::ARCZonalShift
978
1148
  # a few minutes, for existing, in-progress connections in the
979
1149
  # Availability Zone to complete.
980
1150
  #
981
- # For more information, see [Zonal shift][1] in the Amazon Route 53
982
- # Application Recovery Controller Developer Guide.
1151
+ # For more information, see [Zonal shift][5] in the Amazon Application
1152
+ # Recovery Controller Developer Guide.
983
1153
  #
984
1154
  #
985
1155
  #
986
- # [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.html
1156
+ # [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html
1157
+ # [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html
1158
+ # [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html
1159
+ # [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html
1160
+ # [5]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.html
1161
+ #
1162
+ # @option params [required, String] :resource_identifier
1163
+ # The identifier for the resource that Amazon Web Services shifts
1164
+ # traffic for. The identifier is the Amazon Resource Name (ARN) for the
1165
+ # resource.
1166
+ #
1167
+ # Amazon Application Recovery Controller currently supports enabling the
1168
+ # following resources for zonal shift and zonal autoshift:
1169
+ #
1170
+ # * [Amazon EC2 Auto Scaling groups][1]
1171
+ #
1172
+ # * [Amazon Elastic Kubernetes Service][2]
1173
+ #
1174
+ # * [Application Load Balancer][3]
1175
+ #
1176
+ # * [Network Load Balancer][4]
1177
+ #
1178
+ #
1179
+ #
1180
+ # [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html
1181
+ # [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html
1182
+ # [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html
1183
+ # [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html
987
1184
  #
988
1185
  # @option params [required, String] :away_from
989
1186
  # The Availability Zone (for example, `use1-az1`) that traffic is moved
@@ -991,11 +1188,6 @@ module Aws::ARCZonalShift
991
1188
  # shift expires or you cancel it, traffic for the resource is instead
992
1189
  # moved to other Availability Zones in the Amazon Web Services Region.
993
1190
  #
994
- # @option params [required, String] :comment
995
- # A comment that you enter about the zonal shift. Only the latest
996
- # comment is retained; no comment history is maintained. A new comment
997
- # overwrites any existing comment string.
998
- #
999
1191
  # @option params [required, String] :expires_in
1000
1192
  # The length of time that you want a zonal shift to be active, which ARC
1001
1193
  # converts to an expiry time (expiration time). Zonal shifts are
@@ -1017,42 +1209,39 @@ module Aws::ARCZonalShift
1017
1209
  # For example: `20h` means the zonal shift expires in 20 hours. `120m`
1018
1210
  # means the zonal shift expires in 120 minutes (2 hours).
1019
1211
  #
1020
- # @option params [required, String] :resource_identifier
1021
- # The identifier for the resource that Amazon Web Services shifts
1022
- # traffic for. The identifier is the Amazon Resource Name (ARN) for the
1023
- # resource.
1024
- #
1025
- # At this time, supported resources are Network Load Balancers and
1026
- # Application Load Balancers with cross-zone load balancing turned off.
1212
+ # @option params [required, String] :comment
1213
+ # A comment that you enter about the zonal shift. Only the latest
1214
+ # comment is retained; no comment history is maintained. A new comment
1215
+ # overwrites any existing comment string.
1027
1216
  #
1028
1217
  # @return [Types::ZonalShift] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1029
1218
  #
1219
+ # * {Types::ZonalShift#zonal_shift_id #zonal_shift_id} => String
1220
+ # * {Types::ZonalShift#resource_identifier #resource_identifier} => String
1030
1221
  # * {Types::ZonalShift#away_from #away_from} => String
1031
- # * {Types::ZonalShift#comment #comment} => String
1032
1222
  # * {Types::ZonalShift#expiry_time #expiry_time} => Time
1033
- # * {Types::ZonalShift#resource_identifier #resource_identifier} => String
1034
1223
  # * {Types::ZonalShift#start_time #start_time} => Time
1035
1224
  # * {Types::ZonalShift#status #status} => String
1036
- # * {Types::ZonalShift#zonal_shift_id #zonal_shift_id} => String
1225
+ # * {Types::ZonalShift#comment #comment} => String
1037
1226
  #
1038
1227
  # @example Request syntax with placeholder values
1039
1228
  #
1040
1229
  # resp = client.start_zonal_shift({
1230
+ # resource_identifier: "ResourceIdentifier", # required
1041
1231
  # away_from: "AvailabilityZone", # required
1042
- # comment: "ZonalShiftComment", # required
1043
1232
  # expires_in: "ExpiresIn", # required
1044
- # resource_identifier: "ResourceIdentifier", # required
1233
+ # comment: "ZonalShiftComment", # required
1045
1234
  # })
1046
1235
  #
1047
1236
  # @example Response structure
1048
1237
  #
1238
+ # resp.zonal_shift_id #=> String
1239
+ # resp.resource_identifier #=> String
1049
1240
  # resp.away_from #=> String
1050
- # resp.comment #=> String
1051
1241
  # resp.expiry_time #=> Time
1052
- # resp.resource_identifier #=> String
1053
1242
  # resp.start_time #=> Time
1054
1243
  # resp.status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
1055
- # resp.zonal_shift_id #=> String
1244
+ # resp.comment #=> String
1056
1245
  #
1057
1246
  # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/StartZonalShift AWS API Documentation
1058
1247
  #
@@ -1073,8 +1262,8 @@ module Aws::ARCZonalShift
1073
1262
  # one or more of your resources is included in the autoshift.
1074
1263
  #
1075
1264
  # For more information, see [ Notifications for practice runs and
1076
- # autoshifts][1] in the Amazon Route 53 Application Recovery Controller
1077
- # Developer Guide.
1265
+ # autoshifts][1] in the Amazon Application Recovery Controller Developer
1266
+ # Guide.
1078
1267
  #
1079
1268
  #
1080
1269
  #
@@ -1115,18 +1304,10 @@ module Aws::ARCZonalShift
1115
1304
  # outcome alarm; or add, change, or remove blocking dates or time
1116
1305
  # windows.
1117
1306
  #
1118
- # @option params [Array<String>] :blocked_dates
1119
- # Add, change, or remove blocked dates for a practice run in zonal
1120
- # autoshift.
1121
- #
1122
- # Optionally, you can block practice runs for specific calendar dates.
1123
- # The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you
1124
- # specify dates, that dates and times for practice runs are in UTC.
1125
- # Separate multiple blocked dates with spaces.
1126
- #
1127
- # For example, if you have an application update scheduled to launch on
1128
- # May 1, 2024, and you don't want practice runs to shift traffic away
1129
- # at that time, you could set a blocked date for `2024-05-01`.
1307
+ # @option params [required, String] :resource_identifier
1308
+ # The identifier for the resource that you want to update the practice
1309
+ # run configuration for. The identifier is the Amazon Resource Name
1310
+ # (ARN) for the resource.
1130
1311
  #
1131
1312
  # @option params [Array<String>] :blocked_windows
1132
1313
  # Add, change, or remove windows of days and times for when you can,
@@ -1143,6 +1324,19 @@ module Aws::ARCZonalShift
1143
1324
  # times as blocked windows, for example: `MON-20:30-21:30
1144
1325
  # WED-20:30-21:30 FRI-20:30-21:30`.
1145
1326
  #
1327
+ # @option params [Array<String>] :blocked_dates
1328
+ # Add, change, or remove blocked dates for a practice run in zonal
1329
+ # autoshift.
1330
+ #
1331
+ # Optionally, you can block practice runs for specific calendar dates.
1332
+ # The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you
1333
+ # specify dates, that dates and times for practice runs are in UTC.
1334
+ # Separate multiple blocked dates with spaces.
1335
+ #
1336
+ # For example, if you have an application update scheduled to launch on
1337
+ # May 1, 2024, and you don't want practice runs to shift traffic away
1338
+ # at that time, you could set a blocked date for `2024-05-01`.
1339
+ #
1146
1340
  # @option params [Array<Types::ControlCondition>] :blocking_alarms
1147
1341
  # Add, change, or remove the Amazon CloudWatch alarm that you optionally
1148
1342
  # specify as the blocking alarm for practice runs.
@@ -1151,53 +1345,48 @@ module Aws::ARCZonalShift
1151
1345
  # Specify a new the Amazon CloudWatch alarm as the outcome alarm for
1152
1346
  # practice runs.
1153
1347
  #
1154
- # @option params [required, String] :resource_identifier
1155
- # The identifier for the resource that you want to update the practice
1156
- # run configuration for. The identifier is the Amazon Resource Name
1157
- # (ARN) for the resource.
1158
- #
1159
1348
  # @return [Types::UpdatePracticeRunConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1160
1349
  #
1161
1350
  # * {Types::UpdatePracticeRunConfigurationResponse#arn #arn} => String
1162
1351
  # * {Types::UpdatePracticeRunConfigurationResponse#name #name} => String
1163
- # * {Types::UpdatePracticeRunConfigurationResponse#practice_run_configuration #practice_run_configuration} => Types::PracticeRunConfiguration
1164
1352
  # * {Types::UpdatePracticeRunConfigurationResponse#zonal_autoshift_status #zonal_autoshift_status} => String
1353
+ # * {Types::UpdatePracticeRunConfigurationResponse#practice_run_configuration #practice_run_configuration} => Types::PracticeRunConfiguration
1165
1354
  #
1166
1355
  # @example Request syntax with placeholder values
1167
1356
  #
1168
1357
  # resp = client.update_practice_run_configuration({
1169
- # blocked_dates: ["BlockedDate"],
1358
+ # resource_identifier: "ResourceIdentifier", # required
1170
1359
  # blocked_windows: ["BlockedWindow"],
1360
+ # blocked_dates: ["BlockedDate"],
1171
1361
  # blocking_alarms: [
1172
1362
  # {
1173
- # alarm_identifier: "MetricIdentifier", # required
1174
1363
  # type: "CLOUDWATCH", # required, accepts CLOUDWATCH
1364
+ # alarm_identifier: "MetricIdentifier", # required
1175
1365
  # },
1176
1366
  # ],
1177
1367
  # outcome_alarms: [
1178
1368
  # {
1179
- # alarm_identifier: "MetricIdentifier", # required
1180
1369
  # type: "CLOUDWATCH", # required, accepts CLOUDWATCH
1370
+ # alarm_identifier: "MetricIdentifier", # required
1181
1371
  # },
1182
1372
  # ],
1183
- # resource_identifier: "ResourceIdentifier", # required
1184
1373
  # })
1185
1374
  #
1186
1375
  # @example Response structure
1187
1376
  #
1188
1377
  # resp.arn #=> String
1189
1378
  # resp.name #=> String
1190
- # resp.practice_run_configuration.blocked_dates #=> Array
1191
- # resp.practice_run_configuration.blocked_dates[0] #=> String
1192
- # resp.practice_run_configuration.blocked_windows #=> Array
1193
- # resp.practice_run_configuration.blocked_windows[0] #=> String
1379
+ # resp.zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
1194
1380
  # resp.practice_run_configuration.blocking_alarms #=> Array
1195
- # resp.practice_run_configuration.blocking_alarms[0].alarm_identifier #=> String
1196
1381
  # resp.practice_run_configuration.blocking_alarms[0].type #=> String, one of "CLOUDWATCH"
1382
+ # resp.practice_run_configuration.blocking_alarms[0].alarm_identifier #=> String
1197
1383
  # resp.practice_run_configuration.outcome_alarms #=> Array
1198
- # resp.practice_run_configuration.outcome_alarms[0].alarm_identifier #=> String
1199
1384
  # resp.practice_run_configuration.outcome_alarms[0].type #=> String, one of "CLOUDWATCH"
1200
- # resp.zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
1385
+ # resp.practice_run_configuration.outcome_alarms[0].alarm_identifier #=> String
1386
+ # resp.practice_run_configuration.blocked_windows #=> Array
1387
+ # resp.practice_run_configuration.blocked_windows[0] #=> String
1388
+ # resp.practice_run_configuration.blocked_dates #=> Array
1389
+ # resp.practice_run_configuration.blocked_dates[0] #=> String
1201
1390
  #
1202
1391
  # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdatePracticeRunConfiguration AWS API Documentation
1203
1392
  #
@@ -1210,11 +1399,11 @@ module Aws::ARCZonalShift
1210
1399
 
1211
1400
  # The zonal autoshift configuration for a resource includes the practice
1212
1401
  # run configuration and the status for running autoshifts, zonal
1213
- # autoshift status. When a resource has a practice run configuation,
1214
- # Route 53 ARC starts weekly zonal shifts for the resource, to shift
1215
- # traffic away from an Availability Zone. Weekly practice runs help you
1216
- # to make sure that your application can continue to operate normally
1217
- # with the loss of one Availability Zone.
1402
+ # autoshift status. When a resource has a practice run configuation, ARC
1403
+ # starts weekly zonal shifts for the resource, to shift traffic away
1404
+ # from an Availability Zone. Weekly practice runs help you to make sure
1405
+ # that your application can continue to operate normally with the loss
1406
+ # of one Availability Zone.
1218
1407
  #
1219
1408
  # You can update the zonal autoshift autoshift status to enable or
1220
1409
  # disable zonal autoshift. When zonal autoshift is `ENABLED`, you
@@ -1261,10 +1450,13 @@ module Aws::ARCZonalShift
1261
1450
  req.send_request(options)
1262
1451
  end
1263
1452
 
1264
- # Update an active zonal shift in Amazon Route 53 Application Recovery
1265
- # Controller in your Amazon Web Services account. You can update a zonal
1266
- # shift to set a new expiration, or edit or replace the comment for the
1267
- # zonal shift.
1453
+ # Update an active zonal shift in Amazon Application Recovery Controller
1454
+ # in your Amazon Web Services account. You can update a zonal shift to
1455
+ # set a new expiration, or edit or replace the comment for the zonal
1456
+ # shift.
1457
+ #
1458
+ # @option params [required, String] :zonal_shift_id
1459
+ # The identifier of a zonal shift.
1268
1460
  #
1269
1461
  # @option params [String] :comment
1270
1462
  # A comment that you enter about the zonal shift. Only the latest
@@ -1292,36 +1484,33 @@ module Aws::ARCZonalShift
1292
1484
  # For example: `20h` means the zonal shift expires in 20 hours. `120m`
1293
1485
  # means the zonal shift expires in 120 minutes (2 hours).
1294
1486
  #
1295
- # @option params [required, String] :zonal_shift_id
1296
- # The identifier of a zonal shift.
1297
- #
1298
1487
  # @return [Types::ZonalShift] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1299
1488
  #
1489
+ # * {Types::ZonalShift#zonal_shift_id #zonal_shift_id} => String
1490
+ # * {Types::ZonalShift#resource_identifier #resource_identifier} => String
1300
1491
  # * {Types::ZonalShift#away_from #away_from} => String
1301
- # * {Types::ZonalShift#comment #comment} => String
1302
1492
  # * {Types::ZonalShift#expiry_time #expiry_time} => Time
1303
- # * {Types::ZonalShift#resource_identifier #resource_identifier} => String
1304
1493
  # * {Types::ZonalShift#start_time #start_time} => Time
1305
1494
  # * {Types::ZonalShift#status #status} => String
1306
- # * {Types::ZonalShift#zonal_shift_id #zonal_shift_id} => String
1495
+ # * {Types::ZonalShift#comment #comment} => String
1307
1496
  #
1308
1497
  # @example Request syntax with placeholder values
1309
1498
  #
1310
1499
  # resp = client.update_zonal_shift({
1500
+ # zonal_shift_id: "ZonalShiftId", # required
1311
1501
  # comment: "ZonalShiftComment",
1312
1502
  # expires_in: "ExpiresIn",
1313
- # zonal_shift_id: "ZonalShiftId", # required
1314
1503
  # })
1315
1504
  #
1316
1505
  # @example Response structure
1317
1506
  #
1507
+ # resp.zonal_shift_id #=> String
1508
+ # resp.resource_identifier #=> String
1318
1509
  # resp.away_from #=> String
1319
- # resp.comment #=> String
1320
1510
  # resp.expiry_time #=> Time
1321
- # resp.resource_identifier #=> String
1322
1511
  # resp.start_time #=> Time
1323
1512
  # resp.status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
1324
- # resp.zonal_shift_id #=> String
1513
+ # resp.comment #=> String
1325
1514
  #
1326
1515
  # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdateZonalShift AWS API Documentation
1327
1516
  #
@@ -1350,7 +1539,7 @@ module Aws::ARCZonalShift
1350
1539
  tracer: tracer
1351
1540
  )
1352
1541
  context[:gem_name] = 'aws-sdk-arczonalshift'
1353
- context[:gem_version] = '1.33.0'
1542
+ context[:gem_version] = '1.37.0'
1354
1543
  Seahorse::Client::Request.new(handlers, context)
1355
1544
  end
1356
1545