aws-sdk-ssm 1.4.0 → 1.5.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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-ssm.rb +1 -1
- data/lib/aws-sdk-ssm/client.rb +224 -7
- data/lib/aws-sdk-ssm/client_api.rb +104 -0
- data/lib/aws-sdk-ssm/types.rb +441 -19
- metadata +2 -2
data/lib/aws-sdk-ssm/types.rb
CHANGED
@@ -454,6 +454,13 @@ module Aws::SSM
|
|
454
454
|
# are executed in order.
|
455
455
|
# @return [Array<Types::StepExecution>]
|
456
456
|
#
|
457
|
+
# @!attribute [rw] step_executions_truncated
|
458
|
+
# A boolean value that indicates if the response contains the full
|
459
|
+
# list of the Automation step executions. If true, use the
|
460
|
+
# DescribeAutomationStepExecutions API action to get the full list of
|
461
|
+
# step executions.
|
462
|
+
# @return [Boolean]
|
463
|
+
#
|
457
464
|
# @!attribute [rw] parameters
|
458
465
|
# The key-value map of execution parameters, which were supplied when
|
459
466
|
# calling StartAutomationExecution.
|
@@ -468,6 +475,53 @@ module Aws::SSM
|
|
468
475
|
# set to Failed.
|
469
476
|
# @return [String]
|
470
477
|
#
|
478
|
+
# @!attribute [rw] mode
|
479
|
+
# The automation execution mode.
|
480
|
+
# @return [String]
|
481
|
+
#
|
482
|
+
# @!attribute [rw] parent_automation_execution_id
|
483
|
+
# The AutomationExecutionId of the parent automation.
|
484
|
+
# @return [String]
|
485
|
+
#
|
486
|
+
# @!attribute [rw] executed_by
|
487
|
+
# The Amazon Resource Name (ARN) of the user who executed the
|
488
|
+
# automation.
|
489
|
+
# @return [String]
|
490
|
+
#
|
491
|
+
# @!attribute [rw] current_step_name
|
492
|
+
# The name of the currently executing step.
|
493
|
+
# @return [String]
|
494
|
+
#
|
495
|
+
# @!attribute [rw] current_action
|
496
|
+
# The action of the currently executing step.
|
497
|
+
# @return [String]
|
498
|
+
#
|
499
|
+
# @!attribute [rw] target_parameter_name
|
500
|
+
# The parameter name.
|
501
|
+
# @return [String]
|
502
|
+
#
|
503
|
+
# @!attribute [rw] targets
|
504
|
+
# The specified targets.
|
505
|
+
# @return [Array<Types::Target>]
|
506
|
+
#
|
507
|
+
# @!attribute [rw] resolved_targets
|
508
|
+
# A list of resolved targets in the rate control execution.
|
509
|
+
# @return [Types::ResolvedTargets]
|
510
|
+
#
|
511
|
+
# @!attribute [rw] max_concurrency
|
512
|
+
# The MaxConcurrency value specified by the user when the execution
|
513
|
+
# started.
|
514
|
+
# @return [String]
|
515
|
+
#
|
516
|
+
# @!attribute [rw] max_errors
|
517
|
+
# The MaxErrors value specified by the user when the execution
|
518
|
+
# started.
|
519
|
+
# @return [String]
|
520
|
+
#
|
521
|
+
# @!attribute [rw] target
|
522
|
+
# The target of the execution.
|
523
|
+
# @return [String]
|
524
|
+
#
|
471
525
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AutomationExecution AWS API Documentation
|
472
526
|
#
|
473
527
|
class AutomationExecution < Struct.new(
|
@@ -478,9 +532,21 @@ module Aws::SSM
|
|
478
532
|
:execution_end_time,
|
479
533
|
:automation_execution_status,
|
480
534
|
:step_executions,
|
535
|
+
:step_executions_truncated,
|
481
536
|
:parameters,
|
482
537
|
:outputs,
|
483
|
-
:failure_message
|
538
|
+
:failure_message,
|
539
|
+
:mode,
|
540
|
+
:parent_automation_execution_id,
|
541
|
+
:executed_by,
|
542
|
+
:current_step_name,
|
543
|
+
:current_action,
|
544
|
+
:target_parameter_name,
|
545
|
+
:targets,
|
546
|
+
:resolved_targets,
|
547
|
+
:max_concurrency,
|
548
|
+
:max_errors,
|
549
|
+
:target)
|
484
550
|
include Aws::Structure
|
485
551
|
end
|
486
552
|
|
@@ -491,13 +557,14 @@ module Aws::SSM
|
|
491
557
|
# data as a hash:
|
492
558
|
#
|
493
559
|
# {
|
494
|
-
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus
|
560
|
+
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter
|
495
561
|
# values: ["AutomationExecutionFilterValue"], # required
|
496
562
|
# }
|
497
563
|
#
|
498
564
|
# @!attribute [rw] key
|
499
|
-
#
|
500
|
-
#
|
565
|
+
# One or more keys to limit the results. Valid filter keys include the
|
566
|
+
# following: DocumentNamePrefix, ExecutionStatus, ExecutionId,
|
567
|
+
# ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter.
|
501
568
|
# @return [String]
|
502
569
|
#
|
503
570
|
# @!attribute [rw] values
|
@@ -553,6 +620,52 @@ module Aws::SSM
|
|
553
620
|
# The list of execution outputs as defined in the Automation document.
|
554
621
|
# @return [Hash<String,Array<String>>]
|
555
622
|
#
|
623
|
+
# @!attribute [rw] mode
|
624
|
+
# The Automation execution mode.
|
625
|
+
# @return [String]
|
626
|
+
#
|
627
|
+
# @!attribute [rw] parent_automation_execution_id
|
628
|
+
# The ExecutionId of the parent Automation.
|
629
|
+
# @return [String]
|
630
|
+
#
|
631
|
+
# @!attribute [rw] current_step_name
|
632
|
+
# The name of the currently executing step.
|
633
|
+
# @return [String]
|
634
|
+
#
|
635
|
+
# @!attribute [rw] current_action
|
636
|
+
# The action of the currently executing step.
|
637
|
+
# @return [String]
|
638
|
+
#
|
639
|
+
# @!attribute [rw] failure_message
|
640
|
+
# The list of execution outputs as defined in the Automation document.
|
641
|
+
# @return [String]
|
642
|
+
#
|
643
|
+
# @!attribute [rw] target_parameter_name
|
644
|
+
# The list of execution outputs as defined in the Automation document.
|
645
|
+
# @return [String]
|
646
|
+
#
|
647
|
+
# @!attribute [rw] targets
|
648
|
+
# The targets defined by the user when starting the Automation.
|
649
|
+
# @return [Array<Types::Target>]
|
650
|
+
#
|
651
|
+
# @!attribute [rw] resolved_targets
|
652
|
+
# A list of targets that resolved during the execution.
|
653
|
+
# @return [Types::ResolvedTargets]
|
654
|
+
#
|
655
|
+
# @!attribute [rw] max_concurrency
|
656
|
+
# The MaxConcurrency value specified by the user when starting the
|
657
|
+
# Automation.
|
658
|
+
# @return [String]
|
659
|
+
#
|
660
|
+
# @!attribute [rw] max_errors
|
661
|
+
# The MaxErrors value specified by the user when starting the
|
662
|
+
# Automation.
|
663
|
+
# @return [String]
|
664
|
+
#
|
665
|
+
# @!attribute [rw] target
|
666
|
+
# The list of execution outputs as defined in the Automation document.
|
667
|
+
# @return [String]
|
668
|
+
#
|
556
669
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AutomationExecutionMetadata AWS API Documentation
|
557
670
|
#
|
558
671
|
class AutomationExecutionMetadata < Struct.new(
|
@@ -564,7 +677,18 @@ module Aws::SSM
|
|
564
677
|
:execution_end_time,
|
565
678
|
:executed_by,
|
566
679
|
:log_file,
|
567
|
-
:outputs
|
680
|
+
:outputs,
|
681
|
+
:mode,
|
682
|
+
:parent_automation_execution_id,
|
683
|
+
:current_step_name,
|
684
|
+
:current_action,
|
685
|
+
:failure_message,
|
686
|
+
:target_parameter_name,
|
687
|
+
:targets,
|
688
|
+
:resolved_targets,
|
689
|
+
:max_concurrency,
|
690
|
+
:max_errors,
|
691
|
+
:target)
|
568
692
|
include Aws::Structure
|
569
693
|
end
|
570
694
|
|
@@ -1640,10 +1764,12 @@ module Aws::SSM
|
|
1640
1764
|
# content: "DocumentContent", # required
|
1641
1765
|
# name: "DocumentName", # required
|
1642
1766
|
# document_type: "Command", # accepts Command, Policy, Automation
|
1767
|
+
# document_format: "YAML", # accepts YAML, JSON
|
1768
|
+
# target_type: "TargetType",
|
1643
1769
|
# }
|
1644
1770
|
#
|
1645
1771
|
# @!attribute [rw] content
|
1646
|
-
# A valid JSON string.
|
1772
|
+
# A valid JSON or YAML string.
|
1647
1773
|
# @return [String]
|
1648
1774
|
#
|
1649
1775
|
# @!attribute [rw] name
|
@@ -1655,12 +1781,33 @@ module Aws::SSM
|
|
1655
1781
|
# Policy, Automation, and Command.
|
1656
1782
|
# @return [String]
|
1657
1783
|
#
|
1784
|
+
# @!attribute [rw] document_format
|
1785
|
+
# Specify the document format for the request. The document format can
|
1786
|
+
# be either JSON or YAML. JSON is the default format.
|
1787
|
+
# @return [String]
|
1788
|
+
#
|
1789
|
+
# @!attribute [rw] target_type
|
1790
|
+
# Specify a target type to define the kinds of resources the document
|
1791
|
+
# can run on. For example, to run a document on EC2 instances, specify
|
1792
|
+
# the following value: /AWS::EC2::Instance. If you specify a value of
|
1793
|
+
# '/' the document can run on all types of resources. If you don't
|
1794
|
+
# specify a value, the document can't run on any resources. For a
|
1795
|
+
# list of valid resource types, see [AWS Resource Types Reference][1]
|
1796
|
+
# in the *AWS CloudFormation User Guide*.
|
1797
|
+
#
|
1798
|
+
#
|
1799
|
+
#
|
1800
|
+
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
|
1801
|
+
# @return [String]
|
1802
|
+
#
|
1658
1803
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateDocumentRequest AWS API Documentation
|
1659
1804
|
#
|
1660
1805
|
class CreateDocumentRequest < Struct.new(
|
1661
1806
|
:content,
|
1662
1807
|
:name,
|
1663
|
-
:document_type
|
1808
|
+
:document_type,
|
1809
|
+
:document_format,
|
1810
|
+
:target_type)
|
1664
1811
|
include Aws::Structure
|
1665
1812
|
end
|
1666
1813
|
|
@@ -2400,7 +2547,7 @@ module Aws::SSM
|
|
2400
2547
|
# {
|
2401
2548
|
# filters: [
|
2402
2549
|
# {
|
2403
|
-
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus
|
2550
|
+
# key: "DocumentNamePrefix", # required, accepts DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter
|
2404
2551
|
# values: ["AutomationExecutionFilterValue"], # required
|
2405
2552
|
# },
|
2406
2553
|
# ],
|
@@ -2450,6 +2597,77 @@ module Aws::SSM
|
|
2450
2597
|
include Aws::Structure
|
2451
2598
|
end
|
2452
2599
|
|
2600
|
+
# @note When making an API call, you may pass DescribeAutomationStepExecutionsRequest
|
2601
|
+
# data as a hash:
|
2602
|
+
#
|
2603
|
+
# {
|
2604
|
+
# automation_execution_id: "AutomationExecutionId", # required
|
2605
|
+
# filters: [
|
2606
|
+
# {
|
2607
|
+
# key: "StartTimeBefore", # required, accepts StartTimeBefore, StartTimeAfter, StepExecutionStatus, StepExecutionId, StepName, Action
|
2608
|
+
# values: ["StepExecutionFilterValue"], # required
|
2609
|
+
# },
|
2610
|
+
# ],
|
2611
|
+
# next_token: "NextToken",
|
2612
|
+
# max_results: 1,
|
2613
|
+
# reverse_order: false,
|
2614
|
+
# }
|
2615
|
+
#
|
2616
|
+
# @!attribute [rw] automation_execution_id
|
2617
|
+
# The Automation execution ID for which you want step execution
|
2618
|
+
# descriptions.
|
2619
|
+
# @return [String]
|
2620
|
+
#
|
2621
|
+
# @!attribute [rw] filters
|
2622
|
+
# One or more filters to limit the number of step executions returned
|
2623
|
+
# by the request.
|
2624
|
+
# @return [Array<Types::StepExecutionFilter>]
|
2625
|
+
#
|
2626
|
+
# @!attribute [rw] next_token
|
2627
|
+
# The token for the next set of items to return. (You received this
|
2628
|
+
# token from a previous call.)
|
2629
|
+
# @return [String]
|
2630
|
+
#
|
2631
|
+
# @!attribute [rw] max_results
|
2632
|
+
# The maximum number of items to return for this call. The call also
|
2633
|
+
# returns a token that you can specify in a subsequent call to get the
|
2634
|
+
# next set of results.
|
2635
|
+
# @return [Integer]
|
2636
|
+
#
|
2637
|
+
# @!attribute [rw] reverse_order
|
2638
|
+
# A boolean that indicates whether to list step executions in reverse
|
2639
|
+
# order by start time. The default value is false.
|
2640
|
+
# @return [Boolean]
|
2641
|
+
#
|
2642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAutomationStepExecutionsRequest AWS API Documentation
|
2643
|
+
#
|
2644
|
+
class DescribeAutomationStepExecutionsRequest < Struct.new(
|
2645
|
+
:automation_execution_id,
|
2646
|
+
:filters,
|
2647
|
+
:next_token,
|
2648
|
+
:max_results,
|
2649
|
+
:reverse_order)
|
2650
|
+
include Aws::Structure
|
2651
|
+
end
|
2652
|
+
|
2653
|
+
# @!attribute [rw] step_executions
|
2654
|
+
# A list of details about the current state of all steps that make up
|
2655
|
+
# an execution.
|
2656
|
+
# @return [Array<Types::StepExecution>]
|
2657
|
+
#
|
2658
|
+
# @!attribute [rw] next_token
|
2659
|
+
# The token to use when requesting the next set of items. If there are
|
2660
|
+
# no additional items to return, the string is empty.
|
2661
|
+
# @return [String]
|
2662
|
+
#
|
2663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAutomationStepExecutionsResult AWS API Documentation
|
2664
|
+
#
|
2665
|
+
class DescribeAutomationStepExecutionsResult < Struct.new(
|
2666
|
+
:step_executions,
|
2667
|
+
:next_token)
|
2668
|
+
include Aws::Structure
|
2669
|
+
end
|
2670
|
+
|
2453
2671
|
# @note When making an API call, you may pass DescribeAvailablePatchesRequest
|
2454
2672
|
# data as a hash:
|
2455
2673
|
#
|
@@ -3708,6 +3926,21 @@ module Aws::SSM
|
|
3708
3926
|
# The default version.
|
3709
3927
|
# @return [String]
|
3710
3928
|
#
|
3929
|
+
# @!attribute [rw] document_format
|
3930
|
+
# The document format, either JSON or YAML.
|
3931
|
+
# @return [String]
|
3932
|
+
#
|
3933
|
+
# @!attribute [rw] target_type
|
3934
|
+
# The target type which defines the kinds of resources the document
|
3935
|
+
# can run on. For example, /AWS::EC2::Instance. For a list of valid
|
3936
|
+
# resource types, see [AWS Resource Types Reference][1] in the *AWS
|
3937
|
+
# CloudFormation User Guide*.
|
3938
|
+
#
|
3939
|
+
#
|
3940
|
+
#
|
3941
|
+
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
|
3942
|
+
# @return [String]
|
3943
|
+
#
|
3711
3944
|
# @!attribute [rw] tags
|
3712
3945
|
# The tags, or metadata, that have been applied to the document.
|
3713
3946
|
# @return [Array<Types::Tag>]
|
@@ -3730,6 +3963,8 @@ module Aws::SSM
|
|
3730
3963
|
:schema_version,
|
3731
3964
|
:latest_version,
|
3732
3965
|
:default_version,
|
3966
|
+
:document_format,
|
3967
|
+
:target_type,
|
3733
3968
|
:tags)
|
3734
3969
|
include Aws::Structure
|
3735
3970
|
end
|
@@ -3786,6 +4021,21 @@ module Aws::SSM
|
|
3786
4021
|
# The schema version.
|
3787
4022
|
# @return [String]
|
3788
4023
|
#
|
4024
|
+
# @!attribute [rw] document_format
|
4025
|
+
# The document format, either JSON or YAML.
|
4026
|
+
# @return [String]
|
4027
|
+
#
|
4028
|
+
# @!attribute [rw] target_type
|
4029
|
+
# The target type which defines the kinds of resources the document
|
4030
|
+
# can run on. For example, /AWS::EC2::Instance. For a list of valid
|
4031
|
+
# resource types, see [AWS Resource Types Reference][1] in the *AWS
|
4032
|
+
# CloudFormation User Guide*.
|
4033
|
+
#
|
4034
|
+
#
|
4035
|
+
#
|
4036
|
+
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
|
4037
|
+
# @return [String]
|
4038
|
+
#
|
3789
4039
|
# @!attribute [rw] tags
|
3790
4040
|
# The tags, or metadata, that have been applied to the document.
|
3791
4041
|
# @return [Array<Types::Tag>]
|
@@ -3799,6 +4049,8 @@ module Aws::SSM
|
|
3799
4049
|
:document_version,
|
3800
4050
|
:document_type,
|
3801
4051
|
:schema_version,
|
4052
|
+
:document_format,
|
4053
|
+
:target_type,
|
3802
4054
|
:tags)
|
3803
4055
|
include Aws::Structure
|
3804
4056
|
end
|
@@ -3909,13 +4161,18 @@ module Aws::SSM
|
|
3909
4161
|
# An identifier for the default version of the document.
|
3910
4162
|
# @return [Boolean]
|
3911
4163
|
#
|
4164
|
+
# @!attribute [rw] document_format
|
4165
|
+
# The document format, either JSON or YAML.
|
4166
|
+
# @return [String]
|
4167
|
+
#
|
3912
4168
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentVersionInfo AWS API Documentation
|
3913
4169
|
#
|
3914
4170
|
class DocumentVersionInfo < Struct.new(
|
3915
4171
|
:name,
|
3916
4172
|
:document_version,
|
3917
4173
|
:created_date,
|
3918
|
-
:is_default_version
|
4174
|
+
:is_default_version,
|
4175
|
+
:document_format)
|
3919
4176
|
include Aws::Structure
|
3920
4177
|
end
|
3921
4178
|
|
@@ -4320,6 +4577,7 @@ module Aws::SSM
|
|
4320
4577
|
# {
|
4321
4578
|
# name: "DocumentARN", # required
|
4322
4579
|
# document_version: "DocumentVersion",
|
4580
|
+
# document_format: "YAML", # accepts YAML, JSON
|
4323
4581
|
# }
|
4324
4582
|
#
|
4325
4583
|
# @!attribute [rw] name
|
@@ -4330,11 +4588,17 @@ module Aws::SSM
|
|
4330
4588
|
# The document version for which you want information.
|
4331
4589
|
# @return [String]
|
4332
4590
|
#
|
4591
|
+
# @!attribute [rw] document_format
|
4592
|
+
# Returns the document in the specified format. The document format
|
4593
|
+
# can be either JSON or YAML. JSON is the default format.
|
4594
|
+
# @return [String]
|
4595
|
+
#
|
4333
4596
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetDocumentRequest AWS API Documentation
|
4334
4597
|
#
|
4335
4598
|
class GetDocumentRequest < Struct.new(
|
4336
4599
|
:name,
|
4337
|
-
:document_version
|
4600
|
+
:document_version,
|
4601
|
+
:document_format)
|
4338
4602
|
include Aws::Structure
|
4339
4603
|
end
|
4340
4604
|
|
@@ -4354,13 +4618,18 @@ module Aws::SSM
|
|
4354
4618
|
# The document type.
|
4355
4619
|
# @return [String]
|
4356
4620
|
#
|
4621
|
+
# @!attribute [rw] document_format
|
4622
|
+
# The document format, either JSON or YAML.
|
4623
|
+
# @return [String]
|
4624
|
+
#
|
4357
4625
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetDocumentResult AWS API Documentation
|
4358
4626
|
#
|
4359
4627
|
class GetDocumentResult < Struct.new(
|
4360
4628
|
:name,
|
4361
4629
|
:document_version,
|
4362
4630
|
:content,
|
4363
|
-
:document_type
|
4631
|
+
:document_type,
|
4632
|
+
:document_format)
|
4364
4633
|
include Aws::Structure
|
4365
4634
|
end
|
4366
4635
|
|
@@ -5955,7 +6224,7 @@ module Aws::SSM
|
|
5955
6224
|
# @return [String]
|
5956
6225
|
#
|
5957
6226
|
# @!attribute [rw] data
|
5958
|
-
# The data section in the inventory result entity
|
6227
|
+
# The data section in the inventory result entity JSON.
|
5959
6228
|
# @return [Hash<String,Types::InventoryResultItem>]
|
5960
6229
|
#
|
5961
6230
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/InventoryResultEntity AWS API Documentation
|
@@ -7472,8 +7741,8 @@ module Aws::SSM
|
|
7472
7741
|
# The different events for which you can receive notifications. These
|
7473
7742
|
# events include the following: All (events), InProgress, Success,
|
7474
7743
|
# TimedOut, Cancelled, Failed. To learn more about these events, see
|
7475
|
-
# [Setting Up Events and Notifications][1] in the *
|
7476
|
-
#
|
7744
|
+
# [Setting Up Events and Notifications][1] in the *AWS Systems Manager
|
7745
|
+
# User Guide*.
|
7477
7746
|
#
|
7478
7747
|
#
|
7479
7748
|
#
|
@@ -8607,6 +8876,27 @@ module Aws::SSM
|
|
8607
8876
|
#
|
8608
8877
|
class RemoveTagsFromResourceResult < Aws::EmptyStructure; end
|
8609
8878
|
|
8879
|
+
# Information about targets that resolved during the Automation
|
8880
|
+
# execution.
|
8881
|
+
#
|
8882
|
+
# @!attribute [rw] parameter_values
|
8883
|
+
# A list of parameter values sent to targets that resolved during the
|
8884
|
+
# Automation execution.
|
8885
|
+
# @return [Array<String>]
|
8886
|
+
#
|
8887
|
+
# @!attribute [rw] truncated
|
8888
|
+
# A boolean value indicating whether the resolved target list is
|
8889
|
+
# truncated.
|
8890
|
+
# @return [Boolean]
|
8891
|
+
#
|
8892
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ResolvedTargets AWS API Documentation
|
8893
|
+
#
|
8894
|
+
class ResolvedTargets < Struct.new(
|
8895
|
+
:parameter_values,
|
8896
|
+
:truncated)
|
8897
|
+
include Aws::Structure
|
8898
|
+
end
|
8899
|
+
|
8610
8900
|
# Compliance summary information for a specific resource.
|
8611
8901
|
#
|
8612
8902
|
# @!attribute [rw] compliance_type
|
@@ -8821,7 +9111,7 @@ module Aws::SSM
|
|
8821
9111
|
#
|
8822
9112
|
# {
|
8823
9113
|
# automation_execution_id: "AutomationExecutionId", # required
|
8824
|
-
# signal_type: "Approve", # required, accepts Approve, Reject
|
9114
|
+
# signal_type: "Approve", # required, accepts Approve, Reject, StartStep, StopStep, Resume
|
8825
9115
|
# payload: {
|
8826
9116
|
# "AutomationParameterKey" => ["AutomationParameterValue"],
|
8827
9117
|
# },
|
@@ -9091,6 +9381,16 @@ module Aws::SSM
|
|
9091
9381
|
# "AutomationParameterKey" => ["AutomationParameterValue"],
|
9092
9382
|
# },
|
9093
9383
|
# client_token: "IdempotencyToken",
|
9384
|
+
# mode: "Auto", # accepts Auto, Interactive
|
9385
|
+
# target_parameter_name: "AutomationParameterKey",
|
9386
|
+
# targets: [
|
9387
|
+
# {
|
9388
|
+
# key: "TargetKey",
|
9389
|
+
# values: ["TargetValue"],
|
9390
|
+
# },
|
9391
|
+
# ],
|
9392
|
+
# max_concurrency: "MaxConcurrency",
|
9393
|
+
# max_errors: "MaxErrors",
|
9094
9394
|
# }
|
9095
9395
|
#
|
9096
9396
|
# @!attribute [rw] document_name
|
@@ -9111,13 +9411,58 @@ module Aws::SSM
|
|
9111
9411
|
# insensitive, enforces the UUID format, and can't be reused.
|
9112
9412
|
# @return [String]
|
9113
9413
|
#
|
9414
|
+
# @!attribute [rw] mode
|
9415
|
+
# The execution mode of the automation. Valid modes include the
|
9416
|
+
# following: Auto and Interactive. The default mode is Auto.
|
9417
|
+
# @return [String]
|
9418
|
+
#
|
9419
|
+
# @!attribute [rw] target_parameter_name
|
9420
|
+
# The name of the parameter used as the target resource for the
|
9421
|
+
# rate-controlled execution. Required if you specify Targets.
|
9422
|
+
# @return [String]
|
9423
|
+
#
|
9424
|
+
# @!attribute [rw] targets
|
9425
|
+
# A key-value mapping to target resources. Required if you specify
|
9426
|
+
# TargetParameterName.
|
9427
|
+
# @return [Array<Types::Target>]
|
9428
|
+
#
|
9429
|
+
# @!attribute [rw] max_concurrency
|
9430
|
+
# The maximum number of targets allowed to run this task in parallel.
|
9431
|
+
# You can specify a number, such as 10, or a percentage, such as 10%.
|
9432
|
+
# The default value is 10.
|
9433
|
+
# @return [String]
|
9434
|
+
#
|
9435
|
+
# @!attribute [rw] max_errors
|
9436
|
+
# The number of errors that are allowed before the system stops
|
9437
|
+
# running the automation on additional targets. You can specify either
|
9438
|
+
# an absolute number of errors, for example 10, or a percentage of the
|
9439
|
+
# target set, for example 10%. If you specify 3, for example, the
|
9440
|
+
# system stops running the automation when the fourth error is
|
9441
|
+
# received. If you specify 0, then the system stops running the
|
9442
|
+
# automation on additional targets after the first error result is
|
9443
|
+
# returned. If you run an automation on 50 resources and set
|
9444
|
+
# max-errors to 10%, then the system stops running the automation on
|
9445
|
+
# additional targets when the sixth error is received.
|
9446
|
+
#
|
9447
|
+
# Executions that are already running an automation when max-errors is
|
9448
|
+
# reached are allowed to complete, but some of these executions may
|
9449
|
+
# fail as well. If you need to ensure that there won't be more than
|
9450
|
+
# max-errors failed executions, set max-concurrency to 1 so the
|
9451
|
+
# executions proceed one at a time.
|
9452
|
+
# @return [String]
|
9453
|
+
#
|
9114
9454
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartAutomationExecutionRequest AWS API Documentation
|
9115
9455
|
#
|
9116
9456
|
class StartAutomationExecutionRequest < Struct.new(
|
9117
9457
|
:document_name,
|
9118
9458
|
:document_version,
|
9119
9459
|
:parameters,
|
9120
|
-
:client_token
|
9460
|
+
:client_token,
|
9461
|
+
:mode,
|
9462
|
+
:target_parameter_name,
|
9463
|
+
:targets,
|
9464
|
+
:max_concurrency,
|
9465
|
+
:max_errors)
|
9121
9466
|
include Aws::Structure
|
9122
9467
|
end
|
9123
9468
|
|
@@ -9144,6 +9489,19 @@ module Aws::SSM
|
|
9144
9489
|
# the step.
|
9145
9490
|
# @return [String]
|
9146
9491
|
#
|
9492
|
+
# @!attribute [rw] timeout_seconds
|
9493
|
+
# The timeout seconds of the step.
|
9494
|
+
# @return [Integer]
|
9495
|
+
#
|
9496
|
+
# @!attribute [rw] on_failure
|
9497
|
+
# The action to take if the step fails. The default value is Abort.
|
9498
|
+
# @return [String]
|
9499
|
+
#
|
9500
|
+
# @!attribute [rw] max_attempts
|
9501
|
+
# The maximum number of tries to run the action of the step. The
|
9502
|
+
# default value is 1.
|
9503
|
+
# @return [Integer]
|
9504
|
+
#
|
9147
9505
|
# @!attribute [rw] execution_start_time
|
9148
9506
|
# If a step has begun execution, this contains the time the step
|
9149
9507
|
# started. If the step is in Pending status, this field is not
|
@@ -9185,11 +9543,23 @@ module Aws::SSM
|
|
9185
9543
|
# Information about the Automation failure.
|
9186
9544
|
# @return [Types::FailureDetails]
|
9187
9545
|
#
|
9546
|
+
# @!attribute [rw] step_execution_id
|
9547
|
+
# The unique ID of a step execution.
|
9548
|
+
# @return [String]
|
9549
|
+
#
|
9550
|
+
# @!attribute [rw] overridden_parameters
|
9551
|
+
# A user-specified list of parameters to override when executing a
|
9552
|
+
# step.
|
9553
|
+
# @return [Hash<String,Array<String>>]
|
9554
|
+
#
|
9188
9555
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StepExecution AWS API Documentation
|
9189
9556
|
#
|
9190
9557
|
class StepExecution < Struct.new(
|
9191
9558
|
:step_name,
|
9192
9559
|
:action,
|
9560
|
+
:timeout_seconds,
|
9561
|
+
:on_failure,
|
9562
|
+
:max_attempts,
|
9193
9563
|
:execution_start_time,
|
9194
9564
|
:execution_end_time,
|
9195
9565
|
:step_status,
|
@@ -9198,7 +9568,38 @@ module Aws::SSM
|
|
9198
9568
|
:outputs,
|
9199
9569
|
:response,
|
9200
9570
|
:failure_message,
|
9201
|
-
:failure_details
|
9571
|
+
:failure_details,
|
9572
|
+
:step_execution_id,
|
9573
|
+
:overridden_parameters)
|
9574
|
+
include Aws::Structure
|
9575
|
+
end
|
9576
|
+
|
9577
|
+
# A filter to limit the amount of step execution information returned by
|
9578
|
+
# the call.
|
9579
|
+
#
|
9580
|
+
# @note When making an API call, you may pass StepExecutionFilter
|
9581
|
+
# data as a hash:
|
9582
|
+
#
|
9583
|
+
# {
|
9584
|
+
# key: "StartTimeBefore", # required, accepts StartTimeBefore, StartTimeAfter, StepExecutionStatus, StepExecutionId, StepName, Action
|
9585
|
+
# values: ["StepExecutionFilterValue"], # required
|
9586
|
+
# }
|
9587
|
+
#
|
9588
|
+
# @!attribute [rw] key
|
9589
|
+
# One or more keys to limit the results. Valid filter keys include the
|
9590
|
+
# following: StepName, Action, StepExecutionId, StepExecutionStatus,
|
9591
|
+
# StartTimeBefore, StartTimeAfter.
|
9592
|
+
# @return [String]
|
9593
|
+
#
|
9594
|
+
# @!attribute [rw] values
|
9595
|
+
# The values of the filter key.
|
9596
|
+
# @return [Array<String>]
|
9597
|
+
#
|
9598
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StepExecutionFilter AWS API Documentation
|
9599
|
+
#
|
9600
|
+
class StepExecutionFilter < Struct.new(
|
9601
|
+
:key,
|
9602
|
+
:values)
|
9202
9603
|
include Aws::Structure
|
9203
9604
|
end
|
9204
9605
|
|
@@ -9207,16 +9608,23 @@ module Aws::SSM
|
|
9207
9608
|
#
|
9208
9609
|
# {
|
9209
9610
|
# automation_execution_id: "AutomationExecutionId", # required
|
9611
|
+
# type: "Complete", # accepts Complete, Cancel
|
9210
9612
|
# }
|
9211
9613
|
#
|
9212
9614
|
# @!attribute [rw] automation_execution_id
|
9213
9615
|
# The execution ID of the Automation to stop.
|
9214
9616
|
# @return [String]
|
9215
9617
|
#
|
9618
|
+
# @!attribute [rw] type
|
9619
|
+
# The stop request type. Valid types include the following: Cancel and
|
9620
|
+
# Complete. The default type is Cancel.
|
9621
|
+
# @return [String]
|
9622
|
+
#
|
9216
9623
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StopAutomationExecutionRequest AWS API Documentation
|
9217
9624
|
#
|
9218
9625
|
class StopAutomationExecutionRequest < Struct.new(
|
9219
|
-
:automation_execution_id
|
9626
|
+
:automation_execution_id,
|
9627
|
+
:type)
|
9220
9628
|
include Aws::Structure
|
9221
9629
|
end
|
9222
9630
|
|
@@ -9487,6 +9895,8 @@ module Aws::SSM
|
|
9487
9895
|
# content: "DocumentContent", # required
|
9488
9896
|
# name: "DocumentName", # required
|
9489
9897
|
# document_version: "DocumentVersion",
|
9898
|
+
# document_format: "YAML", # accepts YAML, JSON
|
9899
|
+
# target_type: "TargetType",
|
9490
9900
|
# }
|
9491
9901
|
#
|
9492
9902
|
# @!attribute [rw] content
|
@@ -9501,12 +9911,24 @@ module Aws::SSM
|
|
9501
9911
|
# The version of the document that you want to update.
|
9502
9912
|
# @return [String]
|
9503
9913
|
#
|
9914
|
+
# @!attribute [rw] document_format
|
9915
|
+
# Specify the document format for the new document version. Systems
|
9916
|
+
# Manager supports JSON and YAML documents. JSON is the default
|
9917
|
+
# format.
|
9918
|
+
# @return [String]
|
9919
|
+
#
|
9920
|
+
# @!attribute [rw] target_type
|
9921
|
+
# Specify a new target type for the document.
|
9922
|
+
# @return [String]
|
9923
|
+
#
|
9504
9924
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateDocumentRequest AWS API Documentation
|
9505
9925
|
#
|
9506
9926
|
class UpdateDocumentRequest < Struct.new(
|
9507
9927
|
:content,
|
9508
9928
|
:name,
|
9509
|
-
:document_version
|
9929
|
+
:document_version,
|
9930
|
+
:document_format,
|
9931
|
+
:target_type)
|
9510
9932
|
include Aws::Structure
|
9511
9933
|
end
|
9512
9934
|
|