aws-sdk-ssm 1.85.0 → 1.91.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.
@@ -924,12 +924,12 @@ module Aws::SSM
924
924
  # * For the key *SourceUrl*, the value is an S3 bucket location. For
925
925
  # example:
926
926
  #
927
- # `"Values": [ "s3://my-bucket/my-folder" ]`
927
+ # `"Values": [ "s3://doc-example-bucket/my-folder" ]`
928
928
  #
929
929
  # * For the key *S3FileUrl*, the value is a file in an S3 bucket. For
930
930
  # example:
931
931
  #
932
- # `"Values": [ "s3://my-bucket/my-folder/my-file.py" ]`
932
+ # `"Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]`
933
933
  #
934
934
  # * For the key *AttachmentReference*, the value is constructed from
935
935
  # the name of another SSM document in your account, a version number
@@ -1974,14 +1974,14 @@ module Aws::SSM
1974
1974
  # be stored. This was requested when issuing the command. For example,
1975
1975
  # in the following response:
1976
1976
  #
1977
- # test\_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript
1977
+ # doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
1978
1978
  #
1979
- # test\_folder is the name of the S3 bucket;
1979
+ # doc-example-bucket is the name of the S3 bucket;
1980
1980
  #
1981
1981
  # ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3
1982
1982
  # prefix;
1983
1983
  #
1984
- # i-1234567876543 is the instance ID;
1984
+ # i-02573cafcfEXAMPLE is the instance ID;
1985
1985
  #
1986
1986
  # awsrunShellScript is the name of the plugin.
1987
1987
  # @return [String]
@@ -1991,14 +1991,14 @@ module Aws::SSM
1991
1991
  # command executions should be stored. This was requested when issuing
1992
1992
  # the command. For example, in the following response:
1993
1993
  #
1994
- # test\_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript
1994
+ # doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
1995
1995
  #
1996
- # test\_folder is the name of the S3 bucket;
1996
+ # doc-example-bucket is the name of the S3 bucket;
1997
1997
  #
1998
1998
  # ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3
1999
1999
  # prefix;
2000
2000
  #
2001
- # i-1234567876543 is the instance ID;
2001
+ # i-02573cafcfEXAMPLE is the instance ID;
2002
2002
  #
2003
2003
  # awsrunShellScript is the name of the plugin.
2004
2004
  # @return [String]
@@ -2164,8 +2164,9 @@ module Aws::SSM
2164
2164
  # @return [String]
2165
2165
  #
2166
2166
  # @!attribute [rw] status
2167
- # The status of the compliance item. An item is either COMPLIANT or
2168
- # NON\_COMPLIANT.
2167
+ # The status of the compliance item. An item is either COMPLIANT,
2168
+ # NON\_COMPLIANT, or an empty string (for Windows patches that aren't
2169
+ # applicable).
2169
2170
  # @return [String]
2170
2171
  #
2171
2172
  # @!attribute [rw] details
@@ -3696,12 +3697,12 @@ module Aws::SSM
3696
3697
  # type_name: "InventoryItemTypeName", # required
3697
3698
  # schema_delete_option: "DisableSchema", # accepts DisableSchema, DeleteSchema
3698
3699
  # dry_run: false,
3699
- # client_token: "ClientToken",
3700
+ # client_token: "UUID",
3700
3701
  # }
3701
3702
  #
3702
3703
  # @!attribute [rw] type_name
3703
3704
  # The name of the custom inventory type for which you want to delete
3704
- # either all previously collected data, or the inventory type itself.
3705
+ # either all previously collected data or the inventory type itself.
3705
3706
  # @return [String]
3706
3707
  #
3707
3708
  # @!attribute [rw] schema_delete_option
@@ -5084,7 +5085,7 @@ module Aws::SSM
5084
5085
  # data as a hash:
5085
5086
  #
5086
5087
  # {
5087
- # deletion_id: "InventoryDeletionId",
5088
+ # deletion_id: "UUID",
5088
5089
  # next_token: "NextToken",
5089
5090
  # max_results: 1,
5090
5091
  # }
@@ -6510,18 +6511,60 @@ module Aws::SSM
6510
6511
  # For keys, you can specify one or more tags that have been applied to a
6511
6512
  # document.
6512
6513
  #
6513
- # Other valid values include `Owner`, `Name`, `PlatformTypes`,
6514
- # `DocumentType`, and `TargetType`.
6514
+ # You can also use AWS-provided keys, some of which have specific
6515
+ # allowed values. These keys and their associated values are as follows:
6516
+ #
6517
+ # DocumentType
6518
+ # : * ApplicationConfiguration
6519
+ #
6520
+ # * ApplicationConfigurationSchema
6521
+ #
6522
+ # * Automation
6523
+ #
6524
+ # * ChangeCalendar
6525
+ #
6526
+ # * Command
6527
+ #
6528
+ # * DeploymentStrategy
6529
+ #
6530
+ # * Package
6531
+ #
6532
+ # * Policy
6533
+ #
6534
+ # * Session
6535
+ #
6536
+ # Owner
6537
+ #
6538
+ # : Note that only one `Owner` can be specified in a request. For
6539
+ # example: `Key=Owner,Values=Self`.
6515
6540
  #
6516
- # Note that only one Owner can be specified in a request. For example:
6517
- # `Key=Owner,Values=Self`.
6541
+ # * Amazon
6518
6542
  #
6519
- # If you use Name as a key, you can use a name prefix to return a list
6520
- # of documents. For example, in the AWS CLI, to return a list of all
6521
- # documents that begin with `Te`, run the following command:
6543
+ # * Private
6544
+ #
6545
+ # * Public
6546
+ #
6547
+ # * Self
6548
+ #
6549
+ # * ThirdParty
6550
+ #
6551
+ # PlatformTypes
6552
+ # : * Linux
6553
+ #
6554
+ # * Windows
6555
+ #
6556
+ # `Name` is another AWS-provided key. If you use `Name` as a key, you
6557
+ # can use a name prefix to return a list of documents. For example, in
6558
+ # the AWS CLI, to return a list of all documents that begin with `Te`,
6559
+ # run the following command:
6522
6560
  #
6523
6561
  # `aws ssm list-documents --filters Key=Name,Values=Te`
6524
6562
  #
6563
+ # You can also use the `TargetType` AWS-provided key. For a list of
6564
+ # valid resource type values that can be used with this key, see [AWS
6565
+ # resource and property types reference][1] in the *AWS CloudFormation
6566
+ # User Guide*.
6567
+ #
6525
6568
  # If you specify more than two keys, only documents that are identified
6526
6569
  # by all the tags are returned in the results. If you specify more than
6527
6570
  # two values for a key, documents that are identified by any of the
@@ -6530,12 +6573,16 @@ module Aws::SSM
6530
6573
  # To specify a custom key and value pair, use the format
6531
6574
  # `Key=tag:tagName,Values=valueName`.
6532
6575
  #
6533
- # For example, if you created a Key called region and are using the AWS
6576
+ # For example, if you created a key called region and are using the AWS
6534
6577
  # CLI to call the `list-documents` command:
6535
6578
  #
6536
6579
  # `aws ssm list-documents --filters Key=tag:region,Values=east,west
6537
6580
  # Key=Owner,Values=Self`
6538
6581
  #
6582
+ #
6583
+ #
6584
+ # [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
6585
+ #
6539
6586
  # @note When making an API call, you may pass DocumentKeyValuesFilter
6540
6587
  # data as a hash:
6541
6588
  #
@@ -8380,6 +8427,14 @@ module Aws::SSM
8380
8427
  #
8381
8428
  # @!attribute [rw] parameter_filters
8382
8429
  # Filters to limit the request results.
8430
+ #
8431
+ # <note markdown="1"> For `GetParametersByPath`, the following filter `Key` names are
8432
+ # supported: `Type`, `KeyId`, `Label`, and `DataType`.
8433
+ #
8434
+ # The following `Key` values are not supported for
8435
+ # `GetParametersByPath`\: `tag`, `Name`, `Path`, and `Tier`.
8436
+ #
8437
+ # </note>
8383
8438
  # @return [Array<Types::ParameterStringFilter>]
8384
8439
  #
8385
8440
  # @!attribute [rw] with_decryption
@@ -9171,14 +9226,14 @@ module Aws::SSM
9171
9226
  # @return [Integer]
9172
9227
  #
9173
9228
  # @!attribute [rw] installed_rejected_count
9174
- # The number of instances with patches installed that are specified in
9175
- # a RejectedPatches list. Patches with a status of *InstalledRejected*
9176
- # were typically installed before they were added to a RejectedPatches
9177
- # list.
9229
+ # The number of patches installed on an instance that are specified in
9230
+ # a `RejectedPatches` list. Patches with a status of
9231
+ # *InstalledRejected* were typically installed before they were added
9232
+ # to a `RejectedPatches` list.
9178
9233
  #
9179
- # <note markdown="1"> If ALLOW\_AS\_DEPENDENCY is the specified option for
9180
- # RejectedPatchesAction, the value of InstalledRejectedCount will
9181
- # always be 0 (zero).
9234
+ # <note markdown="1"> If `ALLOW_AS_DEPENDENCY` is the specified option for
9235
+ # `RejectedPatchesAction`, the value of `InstalledRejectedCount` will
9236
+ # always be `0` (zero).
9182
9237
  #
9183
9238
  # </note>
9184
9239
  # @return [Integer]
@@ -9219,8 +9274,8 @@ module Aws::SSM
9219
9274
  # @return [Time]
9220
9275
  #
9221
9276
  # @!attribute [rw] operation
9222
- # The type of patching operation that was performed: SCAN (assess
9223
- # patch compliance state) or INSTALL (install missing patches).
9277
+ # The type of patching operation that was performed: `SCAN` (assess
9278
+ # patch compliance state) or `INSTALL` (install missing patches).
9224
9279
  # @return [String]
9225
9280
  #
9226
9281
  # @!attribute [rw] last_no_reboot_install_operation_time
@@ -11170,9 +11225,9 @@ module Aws::SSM
11170
11225
  # @!attribute [rw] sync_type
11171
11226
  # View a list of resource data syncs according to the sync type.
11172
11227
  # Specify `SyncToDestination` to view resource data syncs that
11173
- # synchronize data to an Amazon S3 buckets. Specify `SyncFromSource`
11174
- # to view resource data syncs from AWS Organizations or from multiple
11175
- # AWS Regions.
11228
+ # synchronize data to an Amazon S3 bucket. Specify `SyncFromSource` to
11229
+ # view resource data syncs from AWS Organizations or from multiple AWS
11230
+ # Regions.
11176
11231
  # @return [String]
11177
11232
  #
11178
11233
  # @!attribute [rw] next_token
@@ -13149,25 +13204,6 @@ module Aws::SSM
13149
13204
  # One or more filters. Use a filter to return a more specific list of
13150
13205
  # results.
13151
13206
  #
13152
- # The `ParameterStringFilter` object is used by the DescribeParameters
13153
- # and GetParametersByPath API actions. However, not all of the pattern
13154
- # values listed for `Key` can be used with both actions.
13155
- #
13156
- # For `DescribeActions`, all of the listed patterns are valid, with the
13157
- # exception of `Label`.
13158
- #
13159
- # For `GetParametersByPath`, the following patterns listed for `Key`
13160
- # are
13161
- # not valid: `Name`, `Path`, and `Tier`.
13162
- #
13163
- # For examples of CLI commands demonstrating valid parameter filter
13164
- # constructions, see [Searching for Systems Manager parameters][1] in
13165
- # the *AWS Systems Manager User Guide*.
13166
- #
13167
- #
13168
- #
13169
- # [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html
13170
- #
13171
13207
  # @note When making an API call, you may pass ParameterStringFilter
13172
13208
  # data as a hash:
13173
13209
  #
@@ -13179,6 +13215,26 @@ module Aws::SSM
13179
13215
  #
13180
13216
  # @!attribute [rw] key
13181
13217
  # The name of the filter.
13218
+ #
13219
+ # <note markdown="1"> The `ParameterStringFilter` object is used by the DescribeParameters
13220
+ # and GetParametersByPath API actions. However, not all of the pattern
13221
+ # values listed for `Key` can be used with both actions.
13222
+ #
13223
+ # For `DescribeActions`, all of the listed patterns are valid, with
13224
+ # the exception of `Label`.
13225
+ #
13226
+ # For `GetParametersByPath`, the following patterns listed for `Key`
13227
+ # are not valid: `tag`, `Name`, `Path`, and `Tier`.
13228
+ #
13229
+ # For examples of CLI commands demonstrating valid parameter filter
13230
+ # constructions, see [Searching for Systems Manager parameters][1] in
13231
+ # the *AWS Systems Manager User Guide*.
13232
+ #
13233
+ # </note>
13234
+ #
13235
+ #
13236
+ #
13237
+ # [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html
13182
13238
  # @return [String]
13183
13239
  #
13184
13240
  # @!attribute [rw] option
@@ -13188,8 +13244,8 @@ module Aws::SSM
13188
13244
  # valid options include `Recursive` and `OneLevel`.)
13189
13245
  #
13190
13246
  # For filters used with GetParametersByPath, valid options include
13191
- # `Equals` and `BeginsWith`. (Exception: For filters using the key
13192
- # `Label`, the only valid option is `Equals`.)
13247
+ # `Equals` and `BeginsWith`. (Exception: For filters using `Label` as
13248
+ # the Key name, the only valid option is `Equals`.)
13193
13249
  # @return [String]
13194
13250
  #
13195
13251
  # @!attribute [rw] values
@@ -13999,6 +14055,12 @@ module Aws::SSM
13999
14055
  # The parameter value that you want to add to the system. Standard
14000
14056
  # parameters have a value limit of 4 KB. Advanced parameters have a
14001
14057
  # value limit of 8 KB.
14058
+ #
14059
+ # <note markdown="1"> Parameters can't be referenced or nested in the values of other
14060
+ # parameters. You can't include `\{\{\}\}` or
14061
+ # `\{\{ssm:parameter-name\}\}` in a parameter value.
14062
+ #
14063
+ # </note>
14002
14064
  # @return [String]
14003
14065
  #
14004
14066
  # @!attribute [rw] type
@@ -16782,8 +16844,7 @@ module Aws::SSM
16782
16844
  end
16783
16845
 
16784
16846
  # The operating systems you specified is not supported, or the operation
16785
- # is not supported for the operating system. Valid operating systems
16786
- # include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.
16847
+ # is not supported for the operating system.
16787
16848
  #
16788
16849
  # @!attribute [rw] message
16789
16850
  # @return [String]
@@ -17637,6 +17698,17 @@ module Aws::SSM
17637
17698
  # The parameters that the task should use during execution. Populate
17638
17699
  # only the fields that match the task type. All other fields should be
17639
17700
  # empty.
17701
+ #
17702
+ # When you update a maintenance window task that has options specified
17703
+ # in `TaskInvocationParameters`, you must provide again all the
17704
+ # `TaskInvocationParameters` values that you want to retain. The
17705
+ # values you do not specify again are removed. For example, suppose
17706
+ # that when you registered a Run Command task, you specified
17707
+ # `TaskInvocationParameters` values for `Comment`,
17708
+ # `NotificationConfig`, and `OutputS3BucketName`. If you update the
17709
+ # maintenance window task and specify only a different
17710
+ # `OutputS3BucketName` value, the values for `Comment` and
17711
+ # `NotificationConfig` are removed.
17640
17712
  # @return [Types::MaintenanceWindowTaskInvocationParameters]
17641
17713
  #
17642
17714
  # @!attribute [rw] priority
@@ -17680,7 +17752,7 @@ module Aws::SSM
17680
17752
  #
17681
17753
  # @!attribute [rw] replace
17682
17754
  # If True, then all fields that are required by the
17683
- # RegisterTaskWithMaintenanceWndow action are also required for this
17755
+ # RegisterTaskWithMaintenanceWindow action are also required for this
17684
17756
  # API request. Optional fields that are not specified are set to null.
17685
17757
  # @return [Boolean]
17686
17758
  #
@@ -0,0 +1,156 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'aws-sdk-core/waiters'
11
+
12
+ module Aws::SSM
13
+ # Waiters are utility methods that poll for a particular state to occur
14
+ # on a client. Waiters can fail after a number of attempts at a polling
15
+ # interval defined for the service client.
16
+ #
17
+ # For a list of operations that can be waited for and the
18
+ # client methods called for each operation, see the table below or the
19
+ # {Client#wait_until} field documentation for the {Client}.
20
+ #
21
+ # # Invoking a Waiter
22
+ # To invoke a waiter, call #wait_until on a {Client}. The first parameter
23
+ # is the waiter name, which is specific to the service client and indicates
24
+ # which operation is being waited for. The second parameter is a hash of
25
+ # parameters that are passed to the client method called by the waiter,
26
+ # which varies according to the waiter name.
27
+ #
28
+ # # Wait Failures
29
+ # To catch errors in a waiter, use WaiterFailed,
30
+ # as shown in the following example.
31
+ #
32
+ # rescue rescue Aws::Waiters::Errors::WaiterFailed => error
33
+ # puts "failed waiting for instance running: #{error.message}
34
+ # end
35
+ #
36
+ # # Configuring a Waiter
37
+ # Each waiter has a default polling interval and a maximum number of
38
+ # attempts it will make before returning control to your program.
39
+ # To set these values, use the `max_attempts` and `delay` parameters
40
+ # in your `#wait_until` call.
41
+ # The following example waits for up to 25 seconds, polling every five seconds.
42
+ #
43
+ # client.wait_until(...) do |w|
44
+ # w.max_attempts = 5
45
+ # w.delay = 5
46
+ # end
47
+ #
48
+ # To disable wait failures, set the value of either of these parameters
49
+ # to `nil`.
50
+ #
51
+ # # Extending a Waiter
52
+ # To modify the behavior of waiters, you can register callbacks that are
53
+ # triggered before each polling attempt and before waiting.
54
+ #
55
+ # The following example implements an exponential backoff in a waiter
56
+ # by doubling the amount of time to wait on every attempt.
57
+ #
58
+ # client.wait_until(...) do |w|
59
+ # w.interval = 0 # disable normal sleep
60
+ # w.before_wait do |n, resp|
61
+ # sleep(n ** 2)
62
+ # end
63
+ # end
64
+ #
65
+ # # Available Waiters
66
+ #
67
+ # The following table lists the valid waiter names, the operations they call,
68
+ # and the default `:delay` and `:max_attempts` values.
69
+ #
70
+ # | waiter_name | params | :delay | :max_attempts |
71
+ # | ---------------- | ------------------------------- | -------- | ------------- |
72
+ # | command_executed | {Client#get_command_invocation} | 5 | 20 |
73
+ #
74
+ module Waiters
75
+
76
+ class CommandExecuted
77
+
78
+ # @param [Hash] options
79
+ # @option options [required, Client] :client
80
+ # @option options [Integer] :max_attempts (20)
81
+ # @option options [Integer] :delay (5)
82
+ # @option options [Proc] :before_attempt
83
+ # @option options [Proc] :before_wait
84
+ def initialize(options)
85
+ @client = options.fetch(:client)
86
+ @waiter = Aws::Waiters::Waiter.new({
87
+ max_attempts: 20,
88
+ delay: 5,
89
+ poller: Aws::Waiters::Poller.new(
90
+ operation_name: :get_command_invocation,
91
+ acceptors: [
92
+ {
93
+ "expected" => "Pending",
94
+ "matcher" => "path",
95
+ "state" => "retry",
96
+ "argument" => "status"
97
+ },
98
+ {
99
+ "expected" => "InProgress",
100
+ "matcher" => "path",
101
+ "state" => "retry",
102
+ "argument" => "status"
103
+ },
104
+ {
105
+ "expected" => "Delayed",
106
+ "matcher" => "path",
107
+ "state" => "retry",
108
+ "argument" => "status"
109
+ },
110
+ {
111
+ "expected" => "Success",
112
+ "matcher" => "path",
113
+ "state" => "success",
114
+ "argument" => "status"
115
+ },
116
+ {
117
+ "expected" => "Cancelled",
118
+ "matcher" => "path",
119
+ "state" => "failure",
120
+ "argument" => "status"
121
+ },
122
+ {
123
+ "expected" => "TimedOut",
124
+ "matcher" => "path",
125
+ "state" => "failure",
126
+ "argument" => "status"
127
+ },
128
+ {
129
+ "expected" => "Failed",
130
+ "matcher" => "path",
131
+ "state" => "failure",
132
+ "argument" => "status"
133
+ },
134
+ {
135
+ "expected" => "Cancelling",
136
+ "matcher" => "path",
137
+ "state" => "failure",
138
+ "argument" => "status"
139
+ }
140
+ ]
141
+ )
142
+ }.merge(options))
143
+ end
144
+
145
+ # @option (see Client#get_command_invocation)
146
+ # @return (see Client#get_command_invocation)
147
+ def wait(params = {})
148
+ @waiter.wait(client: @client, params: params)
149
+ end
150
+
151
+ # @api private
152
+ attr_reader :waiter
153
+
154
+ end
155
+ end
156
+ end