aws-sdk-finspacedata 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,177 @@
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::FinSpaceData
11
+ # @api private
12
+ module ClientApi
13
+
14
+ include Seahorse::Model
15
+
16
+ AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
17
+ ChangeType = Shapes::StringShape.new(name: 'ChangeType')
18
+ ChangesetInfo = Shapes::StructureShape.new(name: 'ChangesetInfo')
19
+ ChangesetStatus = Shapes::StringShape.new(name: 'ChangesetStatus')
20
+ CreateChangesetRequest = Shapes::StructureShape.new(name: 'CreateChangesetRequest')
21
+ CreateChangesetResponse = Shapes::StructureShape.new(name: 'CreateChangesetResponse')
22
+ Credentials = Shapes::StructureShape.new(name: 'Credentials')
23
+ ErrorCategory = Shapes::StringShape.new(name: 'ErrorCategory')
24
+ ErrorInfo = Shapes::StructureShape.new(name: 'ErrorInfo')
25
+ FormatType = Shapes::StringShape.new(name: 'FormatType')
26
+ GetProgrammaticAccessCredentialsRequest = Shapes::StructureShape.new(name: 'GetProgrammaticAccessCredentialsRequest')
27
+ GetProgrammaticAccessCredentialsResponse = Shapes::StructureShape.new(name: 'GetProgrammaticAccessCredentialsResponse')
28
+ GetWorkingLocationRequest = Shapes::StructureShape.new(name: 'GetWorkingLocationRequest')
29
+ GetWorkingLocationResponse = Shapes::StructureShape.new(name: 'GetWorkingLocationResponse')
30
+ IdType = Shapes::StringShape.new(name: 'IdType')
31
+ InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
32
+ ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
33
+ SessionDuration = Shapes::IntegerShape.new(name: 'SessionDuration')
34
+ SourceType = Shapes::StringShape.new(name: 'SourceType')
35
+ ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
36
+ Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
37
+ ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
38
+ arn = Shapes::StringShape.new(name: 'arn')
39
+ errorMessage = Shapes::StringShape.new(name: 'errorMessage')
40
+ locationType = Shapes::StringShape.new(name: 'locationType')
41
+ stringMap = Shapes::MapShape.new(name: 'stringMap')
42
+ stringMapKey = Shapes::StringShape.new(name: 'stringMapKey')
43
+ stringMapValue = Shapes::StringShape.new(name: 'stringMapValue')
44
+ stringValue = Shapes::StringShape.new(name: 'stringValue')
45
+ stringValueLength1to1024 = Shapes::StringShape.new(name: 'stringValueLength1to1024')
46
+ stringValueLength1to255 = Shapes::StringShape.new(name: 'stringValueLength1to255')
47
+ stringValueLength1to63 = Shapes::StringShape.new(name: 'stringValueLength1to63')
48
+ stringValueMaxLength1000 = Shapes::StringShape.new(name: 'stringValueMaxLength1000')
49
+
50
+ AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
51
+ AccessDeniedException.struct_class = Types::AccessDeniedException
52
+
53
+ ChangesetInfo.add_member(:id, Shapes::ShapeRef.new(shape: IdType, location_name: "id"))
54
+ ChangesetInfo.add_member(:changeset_arn, Shapes::ShapeRef.new(shape: arn, location_name: "changesetArn"))
55
+ ChangesetInfo.add_member(:dataset_id, Shapes::ShapeRef.new(shape: IdType, location_name: "datasetId"))
56
+ ChangesetInfo.add_member(:change_type, Shapes::ShapeRef.new(shape: ChangeType, location_name: "changeType"))
57
+ ChangesetInfo.add_member(:source_type, Shapes::ShapeRef.new(shape: SourceType, location_name: "sourceType"))
58
+ ChangesetInfo.add_member(:source_params, Shapes::ShapeRef.new(shape: stringMap, location_name: "sourceParams"))
59
+ ChangesetInfo.add_member(:format_type, Shapes::ShapeRef.new(shape: FormatType, location_name: "formatType"))
60
+ ChangesetInfo.add_member(:format_params, Shapes::ShapeRef.new(shape: stringMap, location_name: "formatParams"))
61
+ ChangesetInfo.add_member(:create_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "createTimestamp"))
62
+ ChangesetInfo.add_member(:status, Shapes::ShapeRef.new(shape: ChangesetStatus, location_name: "status"))
63
+ ChangesetInfo.add_member(:error_info, Shapes::ShapeRef.new(shape: ErrorInfo, location_name: "errorInfo"))
64
+ ChangesetInfo.add_member(:changeset_labels, Shapes::ShapeRef.new(shape: stringMap, location_name: "changesetLabels"))
65
+ ChangesetInfo.add_member(:updates_changeset_id, Shapes::ShapeRef.new(shape: stringValue, location_name: "updatesChangesetId"))
66
+ ChangesetInfo.add_member(:updated_by_changeset_id, Shapes::ShapeRef.new(shape: stringValue, location_name: "updatedByChangesetId"))
67
+ ChangesetInfo.struct_class = Types::ChangesetInfo
68
+
69
+ CreateChangesetRequest.add_member(:dataset_id, Shapes::ShapeRef.new(shape: IdType, required: true, location: "uri", location_name: "datasetId"))
70
+ CreateChangesetRequest.add_member(:change_type, Shapes::ShapeRef.new(shape: ChangeType, required: true, location_name: "changeType"))
71
+ CreateChangesetRequest.add_member(:source_type, Shapes::ShapeRef.new(shape: SourceType, required: true, location_name: "sourceType"))
72
+ CreateChangesetRequest.add_member(:source_params, Shapes::ShapeRef.new(shape: stringMap, required: true, location_name: "sourceParams"))
73
+ CreateChangesetRequest.add_member(:format_type, Shapes::ShapeRef.new(shape: FormatType, location_name: "formatType"))
74
+ CreateChangesetRequest.add_member(:format_params, Shapes::ShapeRef.new(shape: stringMap, location_name: "formatParams"))
75
+ CreateChangesetRequest.add_member(:tags, Shapes::ShapeRef.new(shape: stringMap, location_name: "tags"))
76
+ CreateChangesetRequest.struct_class = Types::CreateChangesetRequest
77
+
78
+ CreateChangesetResponse.add_member(:changeset, Shapes::ShapeRef.new(shape: ChangesetInfo, location_name: "changeset"))
79
+ CreateChangesetResponse.struct_class = Types::CreateChangesetResponse
80
+
81
+ Credentials.add_member(:access_key_id, Shapes::ShapeRef.new(shape: stringValueLength1to255, location_name: "accessKeyId"))
82
+ Credentials.add_member(:secret_access_key, Shapes::ShapeRef.new(shape: stringValueMaxLength1000, location_name: "secretAccessKey"))
83
+ Credentials.add_member(:session_token, Shapes::ShapeRef.new(shape: stringValueMaxLength1000, location_name: "sessionToken"))
84
+ Credentials.struct_class = Types::Credentials
85
+
86
+ ErrorInfo.add_member(:error_message, Shapes::ShapeRef.new(shape: stringValueMaxLength1000, location_name: "errorMessage"))
87
+ ErrorInfo.add_member(:error_category, Shapes::ShapeRef.new(shape: ErrorCategory, location_name: "errorCategory"))
88
+ ErrorInfo.struct_class = Types::ErrorInfo
89
+
90
+ GetProgrammaticAccessCredentialsRequest.add_member(:duration_in_minutes, Shapes::ShapeRef.new(shape: SessionDuration, location: "querystring", location_name: "durationInMinutes"))
91
+ GetProgrammaticAccessCredentialsRequest.add_member(:environment_id, Shapes::ShapeRef.new(shape: IdType, required: true, location: "querystring", location_name: "environmentId"))
92
+ GetProgrammaticAccessCredentialsRequest.struct_class = Types::GetProgrammaticAccessCredentialsRequest
93
+
94
+ GetProgrammaticAccessCredentialsResponse.add_member(:credentials, Shapes::ShapeRef.new(shape: Credentials, location_name: "credentials"))
95
+ GetProgrammaticAccessCredentialsResponse.add_member(:duration_in_minutes, Shapes::ShapeRef.new(shape: SessionDuration, location_name: "durationInMinutes"))
96
+ GetProgrammaticAccessCredentialsResponse.struct_class = Types::GetProgrammaticAccessCredentialsResponse
97
+
98
+ GetWorkingLocationRequest.add_member(:location_type, Shapes::ShapeRef.new(shape: locationType, location_name: "locationType"))
99
+ GetWorkingLocationRequest.struct_class = Types::GetWorkingLocationRequest
100
+
101
+ GetWorkingLocationResponse.add_member(:s3_uri, Shapes::ShapeRef.new(shape: stringValueLength1to1024, location_name: "s3Uri"))
102
+ GetWorkingLocationResponse.add_member(:s3_path, Shapes::ShapeRef.new(shape: stringValueLength1to1024, location_name: "s3Path"))
103
+ GetWorkingLocationResponse.add_member(:s3_bucket, Shapes::ShapeRef.new(shape: stringValueLength1to63, location_name: "s3Bucket"))
104
+ GetWorkingLocationResponse.struct_class = Types::GetWorkingLocationResponse
105
+
106
+ InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
107
+ InternalServerException.struct_class = Types::InternalServerException
108
+
109
+ ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
110
+ ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
111
+
112
+ ThrottlingException.struct_class = Types::ThrottlingException
113
+
114
+ ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
115
+ ValidationException.struct_class = Types::ValidationException
116
+
117
+ stringMap.key = Shapes::ShapeRef.new(shape: stringMapKey)
118
+ stringMap.value = Shapes::ShapeRef.new(shape: stringMapValue)
119
+
120
+
121
+ # @api private
122
+ API = Seahorse::Model::Api.new.tap do |api|
123
+
124
+ api.version = "2020-07-13"
125
+
126
+ api.metadata = {
127
+ "apiVersion" => "2020-07-13",
128
+ "endpointPrefix" => "finspace-api",
129
+ "jsonVersion" => "1.1",
130
+ "protocol" => "rest-json",
131
+ "serviceAbbreviation" => "FinSpace Data",
132
+ "serviceFullName" => "FinSpace Public API",
133
+ "serviceId" => "finspace data",
134
+ "signatureVersion" => "v4",
135
+ "signingName" => "finspace-api",
136
+ "uid" => "finspace-2020-07-13",
137
+ }
138
+
139
+ api.add_operation(:create_changeset, Seahorse::Model::Operation.new.tap do |o|
140
+ o.name = "CreateChangeset"
141
+ o.http_method = "POST"
142
+ o.http_request_uri = "/datasets/{datasetId}/changesets"
143
+ o.input = Shapes::ShapeRef.new(shape: CreateChangesetRequest)
144
+ o.output = Shapes::ShapeRef.new(shape: CreateChangesetResponse)
145
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
146
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
147
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
148
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
149
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
150
+ end)
151
+
152
+ api.add_operation(:get_programmatic_access_credentials, Seahorse::Model::Operation.new.tap do |o|
153
+ o.name = "GetProgrammaticAccessCredentials"
154
+ o.http_method = "GET"
155
+ o.http_request_uri = "/credentials/programmatic"
156
+ o.input = Shapes::ShapeRef.new(shape: GetProgrammaticAccessCredentialsRequest)
157
+ o.output = Shapes::ShapeRef.new(shape: GetProgrammaticAccessCredentialsResponse)
158
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
159
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
160
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
161
+ end)
162
+
163
+ api.add_operation(:get_working_location, Seahorse::Model::Operation.new.tap do |o|
164
+ o.name = "GetWorkingLocation"
165
+ o.http_method = "POST"
166
+ o.http_request_uri = "/workingLocationV1"
167
+ o.input = Shapes::ShapeRef.new(shape: GetWorkingLocationRequest)
168
+ o.output = Shapes::ShapeRef.new(shape: GetWorkingLocationResponse)
169
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
170
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
171
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
172
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
173
+ end)
174
+ end
175
+
176
+ end
177
+ end
File without changes
@@ -0,0 +1,113 @@
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::FinSpaceData
11
+
12
+ # When FinSpaceData returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::FinSpaceData::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all FinSpaceData errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::FinSpaceData::Errors::ServiceError
20
+ # # rescues all FinSpaceData API errors
21
+ # end
22
+ #
23
+ #
24
+ # ## Request Context
25
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
26
+ # information about the request that generated the error.
27
+ # See {Seahorse::Client::RequestContext} for more information.
28
+ #
29
+ # ## Error Classes
30
+ # * {AccessDeniedException}
31
+ # * {InternalServerException}
32
+ # * {ResourceNotFoundException}
33
+ # * {ThrottlingException}
34
+ # * {ValidationException}
35
+ #
36
+ # Additionally, error classes are dynamically generated for service errors based on the error code
37
+ # if they are not defined above.
38
+ module Errors
39
+
40
+ extend Aws::Errors::DynamicErrors
41
+
42
+ class AccessDeniedException < ServiceError
43
+
44
+ # @param [Seahorse::Client::RequestContext] context
45
+ # @param [String] message
46
+ # @param [Aws::FinSpaceData::Types::AccessDeniedException] data
47
+ def initialize(context, message, data = Aws::EmptyStructure.new)
48
+ super(context, message, data)
49
+ end
50
+
51
+ # @return [String]
52
+ def message
53
+ @message || @data[:message]
54
+ end
55
+ end
56
+
57
+ class InternalServerException < ServiceError
58
+
59
+ # @param [Seahorse::Client::RequestContext] context
60
+ # @param [String] message
61
+ # @param [Aws::FinSpaceData::Types::InternalServerException] data
62
+ def initialize(context, message, data = Aws::EmptyStructure.new)
63
+ super(context, message, data)
64
+ end
65
+
66
+ # @return [String]
67
+ def message
68
+ @message || @data[:message]
69
+ end
70
+ end
71
+
72
+ class ResourceNotFoundException < ServiceError
73
+
74
+ # @param [Seahorse::Client::RequestContext] context
75
+ # @param [String] message
76
+ # @param [Aws::FinSpaceData::Types::ResourceNotFoundException] data
77
+ def initialize(context, message, data = Aws::EmptyStructure.new)
78
+ super(context, message, data)
79
+ end
80
+
81
+ # @return [String]
82
+ def message
83
+ @message || @data[:message]
84
+ end
85
+ end
86
+
87
+ class ThrottlingException < ServiceError
88
+
89
+ # @param [Seahorse::Client::RequestContext] context
90
+ # @param [String] message
91
+ # @param [Aws::FinSpaceData::Types::ThrottlingException] data
92
+ def initialize(context, message, data = Aws::EmptyStructure.new)
93
+ super(context, message, data)
94
+ end
95
+ end
96
+
97
+ class ValidationException < ServiceError
98
+
99
+ # @param [Seahorse::Client::RequestContext] context
100
+ # @param [String] message
101
+ # @param [Aws::FinSpaceData::Types::ValidationException] data
102
+ def initialize(context, message, data = Aws::EmptyStructure.new)
103
+ super(context, message, data)
104
+ end
105
+
106
+ # @return [String]
107
+ def message
108
+ @message || @data[:message]
109
+ end
110
+ end
111
+
112
+ end
113
+ end
@@ -0,0 +1,26 @@
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::FinSpaceData
11
+
12
+ class Resource
13
+
14
+ # @param options ({})
15
+ # @option options [Client] :client
16
+ def initialize(options = {})
17
+ @client = options[:client] || Client.new(options)
18
+ end
19
+
20
+ # @return [Client]
21
+ def client
22
+ @client
23
+ end
24
+
25
+ end
26
+ end
@@ -0,0 +1,408 @@
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::FinSpaceData
11
+ module Types
12
+
13
+ # You do not have sufficient access to perform this action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # A changeset is unit of data in a dataset.
27
+ #
28
+ # @!attribute [rw] id
29
+ # Unique identifier for a changeset.
30
+ # @return [String]
31
+ #
32
+ # @!attribute [rw] changeset_arn
33
+ # The ARN identifier of the changeset.
34
+ # @return [String]
35
+ #
36
+ # @!attribute [rw] dataset_id
37
+ # The unique identifier for the FinSpace dataset in which the
38
+ # changeset is created.
39
+ # @return [String]
40
+ #
41
+ # @!attribute [rw] change_type
42
+ # Change type indicates how a changeset is applied to a dataset.
43
+ #
44
+ # * `REPLACE` - Changeset is considered as a replacement to all prior
45
+ # loaded changesets.
46
+ #
47
+ # * `APPEND` - Changeset is considered as an addition to the end of
48
+ # all prior loaded changesets.
49
+ #
50
+ # * `MODIFY` - Changeset is considered as a replacement to a specific
51
+ # prior ingested changeset.
52
+ # @return [String]
53
+ #
54
+ # @!attribute [rw] source_type
55
+ # Type of the data source from which the files to create the changeset
56
+ # are sourced.
57
+ #
58
+ # * `S3` - Amazon S3.
59
+ #
60
+ # ^
61
+ # @return [String]
62
+ #
63
+ # @!attribute [rw] source_params
64
+ # Source path from which the files to create the changeset are
65
+ # sourced.
66
+ # @return [Hash<String,String>]
67
+ #
68
+ # @!attribute [rw] format_type
69
+ # Format type of the input files loaded into the changeset.
70
+ # @return [String]
71
+ #
72
+ # @!attribute [rw] format_params
73
+ # Structure of the source file(s).
74
+ # @return [Hash<String,String>]
75
+ #
76
+ # @!attribute [rw] create_timestamp
77
+ # The timestamp at which the changeset was created in FinSpace.
78
+ # @return [Time]
79
+ #
80
+ # @!attribute [rw] status
81
+ # The status of changeset creation operation.
82
+ # @return [String]
83
+ #
84
+ # @!attribute [rw] error_info
85
+ # The structure with error messages.
86
+ # @return [Types::ErrorInfo]
87
+ #
88
+ # @!attribute [rw] changeset_labels
89
+ # Tags associated with the changeset.
90
+ # @return [Hash<String,String>]
91
+ #
92
+ # @!attribute [rw] updates_changeset_id
93
+ # Unique identifier of the changeset that is updated.
94
+ # @return [String]
95
+ #
96
+ # @!attribute [rw] updated_by_changeset_id
97
+ # Unique identifier of the changeset that is updated a changeset.
98
+ # @return [String]
99
+ #
100
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ChangesetInfo AWS API Documentation
101
+ #
102
+ class ChangesetInfo < Struct.new(
103
+ :id,
104
+ :changeset_arn,
105
+ :dataset_id,
106
+ :change_type,
107
+ :source_type,
108
+ :source_params,
109
+ :format_type,
110
+ :format_params,
111
+ :create_timestamp,
112
+ :status,
113
+ :error_info,
114
+ :changeset_labels,
115
+ :updates_changeset_id,
116
+ :updated_by_changeset_id)
117
+ SENSITIVE = []
118
+ include Aws::Structure
119
+ end
120
+
121
+ # @note When making an API call, you may pass CreateChangesetRequest
122
+ # data as a hash:
123
+ #
124
+ # {
125
+ # dataset_id: "IdType", # required
126
+ # change_type: "REPLACE", # required, accepts REPLACE, APPEND, MODIFY
127
+ # source_type: "S3", # required, accepts S3
128
+ # source_params: { # required
129
+ # "stringMapKey" => "stringMapValue",
130
+ # },
131
+ # format_type: "CSV", # accepts CSV, JSON, PARQUET, XML
132
+ # format_params: {
133
+ # "stringMapKey" => "stringMapValue",
134
+ # },
135
+ # tags: {
136
+ # "stringMapKey" => "stringMapValue",
137
+ # },
138
+ # }
139
+ #
140
+ # @!attribute [rw] dataset_id
141
+ # The unique identifier for the FinSpace dataset in which the
142
+ # changeset will be created.
143
+ # @return [String]
144
+ #
145
+ # @!attribute [rw] change_type
146
+ # Option to indicate how a changeset will be applied to a dataset.
147
+ #
148
+ # * `REPLACE` - Changeset will be considered as a replacement to all
149
+ # prior loaded changesets.
150
+ #
151
+ # * `APPEND` - Changeset will be considered as an addition to the end
152
+ # of all prior loaded changesets.
153
+ # @return [String]
154
+ #
155
+ # @!attribute [rw] source_type
156
+ # Type of the data source from which the files to create the changeset
157
+ # will be sourced.
158
+ #
159
+ # * `S3` - Amazon S3.
160
+ #
161
+ # ^
162
+ # @return [String]
163
+ #
164
+ # @!attribute [rw] source_params
165
+ # Source path from which the files to create the changeset will be
166
+ # sourced.
167
+ # @return [Hash<String,String>]
168
+ #
169
+ # @!attribute [rw] format_type
170
+ # Format type of the input files being loaded into the changeset.
171
+ # @return [String]
172
+ #
173
+ # @!attribute [rw] format_params
174
+ # Options that define the structure of the source file(s).
175
+ # @return [Hash<String,String>]
176
+ #
177
+ # @!attribute [rw] tags
178
+ # Metadata tags to apply to this changeset.
179
+ # @return [Hash<String,String>]
180
+ #
181
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateChangesetRequest AWS API Documentation
182
+ #
183
+ class CreateChangesetRequest < Struct.new(
184
+ :dataset_id,
185
+ :change_type,
186
+ :source_type,
187
+ :source_params,
188
+ :format_type,
189
+ :format_params,
190
+ :tags)
191
+ SENSITIVE = []
192
+ include Aws::Structure
193
+ end
194
+
195
+ # @!attribute [rw] changeset
196
+ # Returns the changeset details.
197
+ # @return [Types::ChangesetInfo]
198
+ #
199
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateChangesetResponse AWS API Documentation
200
+ #
201
+ class CreateChangesetResponse < Struct.new(
202
+ :changeset)
203
+ SENSITIVE = []
204
+ include Aws::Structure
205
+ end
206
+
207
+ # Set short term API credentials.
208
+ #
209
+ # @!attribute [rw] access_key_id
210
+ # The access key identifier.
211
+ # @return [String]
212
+ #
213
+ # @!attribute [rw] secret_access_key
214
+ # The access key.
215
+ # @return [String]
216
+ #
217
+ # @!attribute [rw] session_token
218
+ # The session token.
219
+ # @return [String]
220
+ #
221
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/Credentials AWS API Documentation
222
+ #
223
+ class Credentials < Struct.new(
224
+ :access_key_id,
225
+ :secret_access_key,
226
+ :session_token)
227
+ SENSITIVE = []
228
+ include Aws::Structure
229
+ end
230
+
231
+ # Error message.
232
+ #
233
+ # @!attribute [rw] error_message
234
+ # The text of the error message.
235
+ # @return [String]
236
+ #
237
+ # @!attribute [rw] error_category
238
+ # The category of the error.
239
+ #
240
+ # * `VALIDATION` -The inputs to this request are invalid.
241
+ #
242
+ # * `SERVICE_QUOTA_EXCEEDED` - Service quotas have been exceeded.
243
+ # Please contact AWS support to increase quotas.
244
+ #
245
+ # * `ACCESS_DENIED` - Missing required permission to perform this
246
+ # request.
247
+ #
248
+ # * `RESOURCE_NOT_FOUND` - One or more inputs to this request were not
249
+ # found.
250
+ #
251
+ # * `THROTTLING` - The system temporarily lacks sufficient resources
252
+ # to process the request.
253
+ #
254
+ # * `INTERNAL_SERVICE_EXCEPTION` - An internal service error has
255
+ # occurred.
256
+ #
257
+ # * `CANCELLED` - A user recoverable error has occurred.
258
+ # @return [String]
259
+ #
260
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ErrorInfo AWS API Documentation
261
+ #
262
+ class ErrorInfo < Struct.new(
263
+ :error_message,
264
+ :error_category)
265
+ SENSITIVE = []
266
+ include Aws::Structure
267
+ end
268
+
269
+ # @note When making an API call, you may pass GetProgrammaticAccessCredentialsRequest
270
+ # data as a hash:
271
+ #
272
+ # {
273
+ # duration_in_minutes: 1,
274
+ # environment_id: "IdType", # required
275
+ # }
276
+ #
277
+ # @!attribute [rw] duration_in_minutes
278
+ # The time duration in which the credentials remain valid.
279
+ # @return [Integer]
280
+ #
281
+ # @!attribute [rw] environment_id
282
+ # The habanero environment identifier.
283
+ # @return [String]
284
+ #
285
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetProgrammaticAccessCredentialsRequest AWS API Documentation
286
+ #
287
+ class GetProgrammaticAccessCredentialsRequest < Struct.new(
288
+ :duration_in_minutes,
289
+ :environment_id)
290
+ SENSITIVE = []
291
+ include Aws::Structure
292
+ end
293
+
294
+ # @!attribute [rw] credentials
295
+ # Returns the programmatic credentials.
296
+ # @return [Types::Credentials]
297
+ #
298
+ # @!attribute [rw] duration_in_minutes
299
+ # Returns the duration in which the credentials will remain valid.
300
+ # @return [Integer]
301
+ #
302
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetProgrammaticAccessCredentialsResponse AWS API Documentation
303
+ #
304
+ class GetProgrammaticAccessCredentialsResponse < Struct.new(
305
+ :credentials,
306
+ :duration_in_minutes)
307
+ SENSITIVE = []
308
+ include Aws::Structure
309
+ end
310
+
311
+ # @note When making an API call, you may pass GetWorkingLocationRequest
312
+ # data as a hash:
313
+ #
314
+ # {
315
+ # location_type: "INGESTION", # accepts INGESTION, SAGEMAKER
316
+ # }
317
+ #
318
+ # @!attribute [rw] location_type
319
+ # Specify the type of the working location.
320
+ #
321
+ # * `SAGEMAKER` - Use the Amazon S3 location as a temporary location
322
+ # to store data content when working with FinSpace Notebooks that
323
+ # run on SageMaker studio.
324
+ #
325
+ # * `INGESTION` - Use the Amazon S3 location as a staging location to
326
+ # copy your data content and then use the location with the
327
+ # changeset creation operation.
328
+ # @return [String]
329
+ #
330
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetWorkingLocationRequest AWS API Documentation
331
+ #
332
+ class GetWorkingLocationRequest < Struct.new(
333
+ :location_type)
334
+ SENSITIVE = []
335
+ include Aws::Structure
336
+ end
337
+
338
+ # @!attribute [rw] s3_uri
339
+ # Returns the Amazon S3 URI for the working location.
340
+ # @return [String]
341
+ #
342
+ # @!attribute [rw] s3_path
343
+ # Returns the Amazon S3 Path for the working location.
344
+ # @return [String]
345
+ #
346
+ # @!attribute [rw] s3_bucket
347
+ # Returns the Amazon S3 bucket name for the working location.
348
+ # @return [String]
349
+ #
350
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetWorkingLocationResponse AWS API Documentation
351
+ #
352
+ class GetWorkingLocationResponse < Struct.new(
353
+ :s3_uri,
354
+ :s3_path,
355
+ :s3_bucket)
356
+ SENSITIVE = []
357
+ include Aws::Structure
358
+ end
359
+
360
+ # The request processing has failed because of an unknown error,
361
+ # exception or failure.
362
+ #
363
+ # @!attribute [rw] message
364
+ # @return [String]
365
+ #
366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/InternalServerException AWS API Documentation
367
+ #
368
+ class InternalServerException < Struct.new(
369
+ :message)
370
+ SENSITIVE = []
371
+ include Aws::Structure
372
+ end
373
+
374
+ # One or more resources can't be found.
375
+ #
376
+ # @!attribute [rw] message
377
+ # @return [String]
378
+ #
379
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ResourceNotFoundException AWS API Documentation
380
+ #
381
+ class ResourceNotFoundException < Struct.new(
382
+ :message)
383
+ SENSITIVE = []
384
+ include Aws::Structure
385
+ end
386
+
387
+ # The request was denied due to request throttling.
388
+ #
389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ThrottlingException AWS API Documentation
390
+ #
391
+ class ThrottlingException < Aws::EmptyStructure; end
392
+
393
+ # The input fails to satisfy the constraints specified by an AWS
394
+ # service.
395
+ #
396
+ # @!attribute [rw] message
397
+ # @return [String]
398
+ #
399
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ValidationException AWS API Documentation
400
+ #
401
+ class ValidationException < Struct.new(
402
+ :message)
403
+ SENSITIVE = []
404
+ include Aws::Structure
405
+ end
406
+
407
+ end
408
+ end