aws-sdk-cloudtraildata 1.0.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.
@@ -0,0 +1,218 @@
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/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::CloudTrailData
11
+ module Types
12
+
13
+ # An event from a source outside of Amazon Web Services that you want
14
+ # CloudTrail to log.
15
+ #
16
+ # @!attribute [rw] event_data
17
+ # The content of an audit event that comes from the event, such as
18
+ # `userIdentity`, `userAgent`, and `eventSource`.
19
+ # @return [String]
20
+ #
21
+ # @!attribute [rw] event_data_checksum
22
+ # A checksum is a base64-SHA256 algorithm that helps you verify that
23
+ # CloudTrail receives the event that matches with the checksum.
24
+ # Calculate the checksum by running a command like the following:
25
+ #
26
+ # `printf %s $eventdata | openssl dgst -binary -sha256 | base64`
27
+ # @return [String]
28
+ #
29
+ # @!attribute [rw] id
30
+ # The original event ID from the source event.
31
+ # @return [String]
32
+ #
33
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-data-2021-08-11/AuditEvent AWS API Documentation
34
+ #
35
+ class AuditEvent < Struct.new(
36
+ :event_data,
37
+ :event_data_checksum,
38
+ :id)
39
+ SENSITIVE = []
40
+ include Aws::Structure
41
+ end
42
+
43
+ # A response that includes successful and failed event results.
44
+ #
45
+ # @!attribute [rw] event_id
46
+ # The event ID assigned by CloudTrail.
47
+ # @return [String]
48
+ #
49
+ # @!attribute [rw] id
50
+ # The original event ID from the source event.
51
+ # @return [String]
52
+ #
53
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-data-2021-08-11/AuditEventResultEntry AWS API Documentation
54
+ #
55
+ class AuditEventResultEntry < Struct.new(
56
+ :event_id,
57
+ :id)
58
+ SENSITIVE = []
59
+ include Aws::Structure
60
+ end
61
+
62
+ # The caller's account ID must be the same as the channel owner's
63
+ # account ID.
64
+ #
65
+ # @!attribute [rw] message
66
+ # @return [String]
67
+ #
68
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-data-2021-08-11/ChannelInsufficientPermission AWS API Documentation
69
+ #
70
+ class ChannelInsufficientPermission < Struct.new(
71
+ :message)
72
+ SENSITIVE = []
73
+ include Aws::Structure
74
+ end
75
+
76
+ # The channel could not be found.
77
+ #
78
+ # @!attribute [rw] message
79
+ # @return [String]
80
+ #
81
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-data-2021-08-11/ChannelNotFound AWS API Documentation
82
+ #
83
+ class ChannelNotFound < Struct.new(
84
+ :message)
85
+ SENSITIVE = []
86
+ include Aws::Structure
87
+ end
88
+
89
+ # The schema type of the event is not supported.
90
+ #
91
+ # @!attribute [rw] message
92
+ # @return [String]
93
+ #
94
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-data-2021-08-11/ChannelUnsupportedSchema AWS API Documentation
95
+ #
96
+ class ChannelUnsupportedSchema < Struct.new(
97
+ :message)
98
+ SENSITIVE = []
99
+ include Aws::Structure
100
+ end
101
+
102
+ # Two or more entries in the request have the same event ID.
103
+ #
104
+ # @!attribute [rw] message
105
+ # @return [String]
106
+ #
107
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-data-2021-08-11/DuplicatedAuditEventId AWS API Documentation
108
+ #
109
+ class DuplicatedAuditEventId < Struct.new(
110
+ :message)
111
+ SENSITIVE = []
112
+ include Aws::Structure
113
+ end
114
+
115
+ # The specified channel ARN is not a valid channel ARN.
116
+ #
117
+ # @!attribute [rw] message
118
+ # @return [String]
119
+ #
120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-data-2021-08-11/InvalidChannelARN AWS API Documentation
121
+ #
122
+ class InvalidChannelARN < Struct.new(
123
+ :message)
124
+ SENSITIVE = []
125
+ include Aws::Structure
126
+ end
127
+
128
+ # @!attribute [rw] audit_events
129
+ # The JSON payload of events that you want to ingest. You can also
130
+ # point to the JSON event payload in a file.
131
+ # @return [Array<Types::AuditEvent>]
132
+ #
133
+ # @!attribute [rw] channel_arn
134
+ # The ARN or ID (the ARN suffix) of a channel.
135
+ # @return [String]
136
+ #
137
+ # @!attribute [rw] external_id
138
+ # A unique identifier that is conditionally required when the
139
+ # channel's resource policy includes an external ID. This value can
140
+ # be any string, such as a passphrase or account number.
141
+ # @return [String]
142
+ #
143
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-data-2021-08-11/PutAuditEventsRequest AWS API Documentation
144
+ #
145
+ class PutAuditEventsRequest < Struct.new(
146
+ :audit_events,
147
+ :channel_arn,
148
+ :external_id)
149
+ SENSITIVE = []
150
+ include Aws::Structure
151
+ end
152
+
153
+ # @!attribute [rw] failed
154
+ # Lists events in the provided event payload that could not be
155
+ # ingested into CloudTrail, and includes the error code and error
156
+ # message returned for events that could not be ingested.
157
+ # @return [Array<Types::ResultErrorEntry>]
158
+ #
159
+ # @!attribute [rw] successful
160
+ # Lists events in the provided event payload that were successfully
161
+ # ingested into CloudTrail.
162
+ # @return [Array<Types::AuditEventResultEntry>]
163
+ #
164
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-data-2021-08-11/PutAuditEventsResponse AWS API Documentation
165
+ #
166
+ class PutAuditEventsResponse < Struct.new(
167
+ :failed,
168
+ :successful)
169
+ SENSITIVE = []
170
+ include Aws::Structure
171
+ end
172
+
173
+ # Includes the error code and error message for events that could not be
174
+ # ingested by CloudTrail.
175
+ #
176
+ # @!attribute [rw] error_code
177
+ # The error code for events that could not be ingested by CloudTrail.
178
+ # Possible error codes include: `FieldTooLong`, `FieldNotFound`,
179
+ # `InvalidChecksum`, `InvalidData`, `InvalidRecipient`,
180
+ # `InvalidEventSource`, `AccountNotSubscribed`, `Throttling`, and
181
+ # `InternalFailure`.
182
+ # @return [String]
183
+ #
184
+ # @!attribute [rw] error_message
185
+ # The message that describes the error for events that could not be
186
+ # ingested by CloudTrail.
187
+ # @return [String]
188
+ #
189
+ # @!attribute [rw] id
190
+ # The original event ID from the source event that could not be
191
+ # ingested by CloudTrail.
192
+ # @return [String]
193
+ #
194
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-data-2021-08-11/ResultErrorEntry AWS API Documentation
195
+ #
196
+ class ResultErrorEntry < Struct.new(
197
+ :error_code,
198
+ :error_message,
199
+ :id)
200
+ SENSITIVE = []
201
+ include Aws::Structure
202
+ end
203
+
204
+ # The operation requested is not supported in this region or account.
205
+ #
206
+ # @!attribute [rw] message
207
+ # @return [String]
208
+ #
209
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-data-2021-08-11/UnsupportedOperationException AWS API Documentation
210
+ #
211
+ class UnsupportedOperationException < Struct.new(
212
+ :message)
213
+ SENSITIVE = []
214
+ include Aws::Structure
215
+ end
216
+
217
+ end
218
+ end
@@ -0,0 +1,57 @@
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/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+
11
+ require 'aws-sdk-core'
12
+ require 'aws-sigv4'
13
+
14
+ require_relative 'aws-sdk-cloudtraildata/types'
15
+ require_relative 'aws-sdk-cloudtraildata/client_api'
16
+ require_relative 'aws-sdk-cloudtraildata/plugins/endpoints.rb'
17
+ require_relative 'aws-sdk-cloudtraildata/client'
18
+ require_relative 'aws-sdk-cloudtraildata/errors'
19
+ require_relative 'aws-sdk-cloudtraildata/resource'
20
+ require_relative 'aws-sdk-cloudtraildata/endpoint_parameters'
21
+ require_relative 'aws-sdk-cloudtraildata/endpoint_provider'
22
+ require_relative 'aws-sdk-cloudtraildata/endpoints'
23
+ require_relative 'aws-sdk-cloudtraildata/customizations'
24
+
25
+ # This module provides support for AWS CloudTrail Data Service. This module is available in the
26
+ # `aws-sdk-cloudtraildata` gem.
27
+ #
28
+ # # Client
29
+ #
30
+ # The {Client} class provides one method for each API operation. Operation
31
+ # methods each accept a hash of request parameters and return a response
32
+ # structure.
33
+ #
34
+ # cloud_trail_data = Aws::CloudTrailData::Client.new
35
+ # resp = cloud_trail_data.put_audit_events(params)
36
+ #
37
+ # See {Client} for more information.
38
+ #
39
+ # # Errors
40
+ #
41
+ # Errors returned from AWS CloudTrail Data Service are defined in the
42
+ # {Errors} module and all extend {Errors::ServiceError}.
43
+ #
44
+ # begin
45
+ # # do stuff
46
+ # rescue Aws::CloudTrailData::Errors::ServiceError
47
+ # # rescues all AWS CloudTrail Data Service API errors
48
+ # end
49
+ #
50
+ # See {Errors} for more information.
51
+ #
52
+ # @!group service
53
+ module Aws::CloudTrailData
54
+
55
+ GEM_VERSION = '1.0.0'
56
+
57
+ end
metadata ADDED
@@ -0,0 +1,94 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: aws-sdk-cloudtraildata
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Amazon Web Services
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2023-01-31 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: aws-sdk-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '3'
20
+ - - ">="
21
+ - !ruby/object:Gem::Version
22
+ version: 3.165.0
23
+ type: :runtime
24
+ prerelease: false
25
+ version_requirements: !ruby/object:Gem::Requirement
26
+ requirements:
27
+ - - "~>"
28
+ - !ruby/object:Gem::Version
29
+ version: '3'
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: 3.165.0
33
+ - !ruby/object:Gem::Dependency
34
+ name: aws-sigv4
35
+ requirement: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '1.1'
40
+ type: :runtime
41
+ prerelease: false
42
+ version_requirements: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - "~>"
45
+ - !ruby/object:Gem::Version
46
+ version: '1.1'
47
+ description: Official AWS Ruby gem for AWS CloudTrail Data Service. This gem is part
48
+ of the AWS SDK for Ruby.
49
+ email:
50
+ - aws-dr-rubygems@amazon.com
51
+ executables: []
52
+ extensions: []
53
+ extra_rdoc_files: []
54
+ files:
55
+ - CHANGELOG.md
56
+ - LICENSE.txt
57
+ - VERSION
58
+ - lib/aws-sdk-cloudtraildata.rb
59
+ - lib/aws-sdk-cloudtraildata/client.rb
60
+ - lib/aws-sdk-cloudtraildata/client_api.rb
61
+ - lib/aws-sdk-cloudtraildata/customizations.rb
62
+ - lib/aws-sdk-cloudtraildata/endpoint_parameters.rb
63
+ - lib/aws-sdk-cloudtraildata/endpoint_provider.rb
64
+ - lib/aws-sdk-cloudtraildata/endpoints.rb
65
+ - lib/aws-sdk-cloudtraildata/errors.rb
66
+ - lib/aws-sdk-cloudtraildata/plugins/endpoints.rb
67
+ - lib/aws-sdk-cloudtraildata/resource.rb
68
+ - lib/aws-sdk-cloudtraildata/types.rb
69
+ homepage: https://github.com/aws/aws-sdk-ruby
70
+ licenses:
71
+ - Apache-2.0
72
+ metadata:
73
+ source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-cloudtraildata
74
+ changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-cloudtraildata/CHANGELOG.md
75
+ post_install_message:
76
+ rdoc_options: []
77
+ require_paths:
78
+ - lib
79
+ required_ruby_version: !ruby/object:Gem::Requirement
80
+ requirements:
81
+ - - ">="
82
+ - !ruby/object:Gem::Version
83
+ version: '2.3'
84
+ required_rubygems_version: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: '0'
89
+ requirements: []
90
+ rubygems_version: 3.1.6
91
+ signing_key:
92
+ specification_version: 4
93
+ summary: AWS SDK for Ruby - AWS CloudTrail Data Service
94
+ test_files: []