aws-sdk-partnercentralchannel 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,1903 @@
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::PartnerCentralChannel
11
+ module Types
12
+
13
+ # Contains details about an accepted channel handshake.
14
+ #
15
+ # @!attribute [rw] id
16
+ # The unique identifier of the accepted handshake.
17
+ # @return [String]
18
+ #
19
+ # @!attribute [rw] arn
20
+ # The Amazon Resource Name (ARN) of the accepted handshake.
21
+ # @return [String]
22
+ #
23
+ # @!attribute [rw] status
24
+ # The current status of the accepted handshake.
25
+ # @return [String]
26
+ #
27
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/AcceptChannelHandshakeDetail AWS API Documentation
28
+ #
29
+ class AcceptChannelHandshakeDetail < Struct.new(
30
+ :id,
31
+ :arn,
32
+ :status)
33
+ SENSITIVE = []
34
+ include Aws::Structure
35
+ end
36
+
37
+ # @!attribute [rw] catalog
38
+ # The catalog identifier for the handshake request.
39
+ # @return [String]
40
+ #
41
+ # @!attribute [rw] identifier
42
+ # The unique identifier of the channel handshake to accept.
43
+ # @return [String]
44
+ #
45
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/AcceptChannelHandshakeRequest AWS API Documentation
46
+ #
47
+ class AcceptChannelHandshakeRequest < Struct.new(
48
+ :catalog,
49
+ :identifier)
50
+ SENSITIVE = []
51
+ include Aws::Structure
52
+ end
53
+
54
+ # @!attribute [rw] channel_handshake_detail
55
+ # Details of the accepted channel handshake.
56
+ # @return [Types::AcceptChannelHandshakeDetail]
57
+ #
58
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/AcceptChannelHandshakeResponse AWS API Documentation
59
+ #
60
+ class AcceptChannelHandshakeResponse < Struct.new(
61
+ :channel_handshake_detail)
62
+ SENSITIVE = []
63
+ include Aws::Structure
64
+ end
65
+
66
+ # The request was denied due to insufficient permissions.
67
+ #
68
+ # @!attribute [rw] message
69
+ # A message describing the access denial.
70
+ # @return [String]
71
+ #
72
+ # @!attribute [rw] reason
73
+ # The reason for the access denial.
74
+ # @return [String]
75
+ #
76
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/AccessDeniedException AWS API Documentation
77
+ #
78
+ class AccessDeniedException < Struct.new(
79
+ :message,
80
+ :reason)
81
+ SENSITIVE = []
82
+ include Aws::Structure
83
+ end
84
+
85
+ # Contains details about a canceled channel handshake.
86
+ #
87
+ # @!attribute [rw] id
88
+ # The unique identifier of the canceled handshake.
89
+ # @return [String]
90
+ #
91
+ # @!attribute [rw] arn
92
+ # The Amazon Resource Name (ARN) of the canceled handshake.
93
+ # @return [String]
94
+ #
95
+ # @!attribute [rw] status
96
+ # The current status of the canceled handshake.
97
+ # @return [String]
98
+ #
99
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/CancelChannelHandshakeDetail AWS API Documentation
100
+ #
101
+ class CancelChannelHandshakeDetail < Struct.new(
102
+ :id,
103
+ :arn,
104
+ :status)
105
+ SENSITIVE = []
106
+ include Aws::Structure
107
+ end
108
+
109
+ # @!attribute [rw] catalog
110
+ # The catalog identifier for the handshake request.
111
+ # @return [String]
112
+ #
113
+ # @!attribute [rw] identifier
114
+ # The unique identifier of the channel handshake to cancel.
115
+ # @return [String]
116
+ #
117
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/CancelChannelHandshakeRequest AWS API Documentation
118
+ #
119
+ class CancelChannelHandshakeRequest < Struct.new(
120
+ :catalog,
121
+ :identifier)
122
+ SENSITIVE = []
123
+ include Aws::Structure
124
+ end
125
+
126
+ # @!attribute [rw] channel_handshake_detail
127
+ # Details of the canceled channel handshake.
128
+ # @return [Types::CancelChannelHandshakeDetail]
129
+ #
130
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/CancelChannelHandshakeResponse AWS API Documentation
131
+ #
132
+ class CancelChannelHandshakeResponse < Struct.new(
133
+ :channel_handshake_detail)
134
+ SENSITIVE = []
135
+ include Aws::Structure
136
+ end
137
+
138
+ # Contains the payload data for different types of channel handshakes.
139
+ #
140
+ # @note ChannelHandshakePayload is a union - when making an API calls you must set exactly one of the members.
141
+ #
142
+ # @!attribute [rw] start_service_period_payload
143
+ # Payload for starting a service period handshake.
144
+ # @return [Types::StartServicePeriodPayload]
145
+ #
146
+ # @!attribute [rw] revoke_service_period_payload
147
+ # Payload for revoking a service period handshake.
148
+ # @return [Types::RevokeServicePeriodPayload]
149
+ #
150
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ChannelHandshakePayload AWS API Documentation
151
+ #
152
+ class ChannelHandshakePayload < Struct.new(
153
+ :start_service_period_payload,
154
+ :revoke_service_period_payload,
155
+ :unknown)
156
+ SENSITIVE = []
157
+ include Aws::Structure
158
+ include Aws::Structure::Union
159
+
160
+ class StartServicePeriodPayload < ChannelHandshakePayload; end
161
+ class RevokeServicePeriodPayload < ChannelHandshakePayload; end
162
+ class Unknown < ChannelHandshakePayload; end
163
+ end
164
+
165
+ # Summary information about a channel handshake.
166
+ #
167
+ # @!attribute [rw] id
168
+ # The unique identifier of the handshake.
169
+ # @return [String]
170
+ #
171
+ # @!attribute [rw] arn
172
+ # The Amazon Resource Name (ARN) of the handshake.
173
+ # @return [String]
174
+ #
175
+ # @!attribute [rw] catalog
176
+ # The catalog identifier associated with the handshake.
177
+ # @return [String]
178
+ #
179
+ # @!attribute [rw] handshake_type
180
+ # The type of the handshake.
181
+ # @return [String]
182
+ #
183
+ # @!attribute [rw] owner_account_id
184
+ # The AWS account ID of the handshake owner.
185
+ # @return [String]
186
+ #
187
+ # @!attribute [rw] sender_account_id
188
+ # The AWS account ID of the handshake sender.
189
+ # @return [String]
190
+ #
191
+ # @!attribute [rw] sender_display_name
192
+ # The display name of the handshake sender.
193
+ # @return [String]
194
+ #
195
+ # @!attribute [rw] receiver_account_id
196
+ # The AWS account ID of the handshake receiver.
197
+ # @return [String]
198
+ #
199
+ # @!attribute [rw] associated_resource_id
200
+ # The identifier of the resource associated with the handshake.
201
+ # @return [String]
202
+ #
203
+ # @!attribute [rw] detail
204
+ # Detailed information about the handshake.
205
+ # @return [Types::HandshakeDetail]
206
+ #
207
+ # @!attribute [rw] created_at
208
+ # The timestamp when the handshake was created.
209
+ # @return [Time]
210
+ #
211
+ # @!attribute [rw] updated_at
212
+ # The timestamp when the handshake was last updated.
213
+ # @return [Time]
214
+ #
215
+ # @!attribute [rw] status
216
+ # The current status of the handshake.
217
+ # @return [String]
218
+ #
219
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ChannelHandshakeSummary AWS API Documentation
220
+ #
221
+ class ChannelHandshakeSummary < Struct.new(
222
+ :id,
223
+ :arn,
224
+ :catalog,
225
+ :handshake_type,
226
+ :owner_account_id,
227
+ :sender_account_id,
228
+ :sender_display_name,
229
+ :receiver_account_id,
230
+ :associated_resource_id,
231
+ :detail,
232
+ :created_at,
233
+ :updated_at,
234
+ :status)
235
+ SENSITIVE = []
236
+ include Aws::Structure
237
+ end
238
+
239
+ # The request could not be completed due to a conflict with the current
240
+ # state of the resource.
241
+ #
242
+ # @!attribute [rw] message
243
+ # A message describing the conflict.
244
+ # @return [String]
245
+ #
246
+ # @!attribute [rw] resource_id
247
+ # The identifier of the resource that caused the conflict.
248
+ # @return [String]
249
+ #
250
+ # @!attribute [rw] resource_type
251
+ # The type of the resource that caused the conflict.
252
+ # @return [String]
253
+ #
254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ConflictException AWS API Documentation
255
+ #
256
+ class ConflictException < Struct.new(
257
+ :message,
258
+ :resource_id,
259
+ :resource_type)
260
+ SENSITIVE = []
261
+ include Aws::Structure
262
+ end
263
+
264
+ # Contains details about a newly created channel handshake.
265
+ #
266
+ # @!attribute [rw] id
267
+ # The unique identifier of the created handshake.
268
+ # @return [String]
269
+ #
270
+ # @!attribute [rw] arn
271
+ # The Amazon Resource Name (ARN) of the created handshake.
272
+ # @return [String]
273
+ #
274
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/CreateChannelHandshakeDetail AWS API Documentation
275
+ #
276
+ class CreateChannelHandshakeDetail < Struct.new(
277
+ :id,
278
+ :arn)
279
+ SENSITIVE = []
280
+ include Aws::Structure
281
+ end
282
+
283
+ # @!attribute [rw] handshake_type
284
+ # The type of handshake to create (e.g., start service period, revoke
285
+ # service period).
286
+ # @return [String]
287
+ #
288
+ # @!attribute [rw] catalog
289
+ # The catalog identifier for the handshake request.
290
+ # @return [String]
291
+ #
292
+ # @!attribute [rw] associated_resource_identifier
293
+ # The identifier of the resource associated with this handshake.
294
+ # @return [String]
295
+ #
296
+ # @!attribute [rw] payload
297
+ # The payload containing specific details for the handshake type.
298
+ # @return [Types::ChannelHandshakePayload]
299
+ #
300
+ # @!attribute [rw] client_token
301
+ # A unique, case-sensitive identifier to ensure idempotency of the
302
+ # request.
303
+ #
304
+ # **A suitable default value is auto-generated.** You should normally
305
+ # not need to pass this option.
306
+ # @return [String]
307
+ #
308
+ # @!attribute [rw] tags
309
+ # Key-value pairs to associate with the channel handshake.
310
+ # @return [Array<Types::Tag>]
311
+ #
312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/CreateChannelHandshakeRequest AWS API Documentation
313
+ #
314
+ class CreateChannelHandshakeRequest < Struct.new(
315
+ :handshake_type,
316
+ :catalog,
317
+ :associated_resource_identifier,
318
+ :payload,
319
+ :client_token,
320
+ :tags)
321
+ SENSITIVE = []
322
+ include Aws::Structure
323
+ end
324
+
325
+ # @!attribute [rw] channel_handshake_detail
326
+ # Details of the created channel handshake.
327
+ # @return [Types::CreateChannelHandshakeDetail]
328
+ #
329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/CreateChannelHandshakeResponse AWS API Documentation
330
+ #
331
+ class CreateChannelHandshakeResponse < Struct.new(
332
+ :channel_handshake_detail)
333
+ SENSITIVE = []
334
+ include Aws::Structure
335
+ end
336
+
337
+ # Contains details about a newly created program management account.
338
+ #
339
+ # @!attribute [rw] id
340
+ # The unique identifier of the created program management account.
341
+ # @return [String]
342
+ #
343
+ # @!attribute [rw] arn
344
+ # The Amazon Resource Name (ARN) of the created program management
345
+ # account.
346
+ # @return [String]
347
+ #
348
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/CreateProgramManagementAccountDetail AWS API Documentation
349
+ #
350
+ class CreateProgramManagementAccountDetail < Struct.new(
351
+ :id,
352
+ :arn)
353
+ SENSITIVE = []
354
+ include Aws::Structure
355
+ end
356
+
357
+ # @!attribute [rw] catalog
358
+ # The catalog identifier for the program management account.
359
+ # @return [String]
360
+ #
361
+ # @!attribute [rw] program
362
+ # The program type for the management account.
363
+ # @return [String]
364
+ #
365
+ # @!attribute [rw] display_name
366
+ # A human-readable name for the program management account.
367
+ # @return [String]
368
+ #
369
+ # @!attribute [rw] account_id
370
+ # The AWS account ID to associate with the program management account.
371
+ # @return [String]
372
+ #
373
+ # @!attribute [rw] client_token
374
+ # A unique, case-sensitive identifier to ensure idempotency of the
375
+ # request.
376
+ #
377
+ # **A suitable default value is auto-generated.** You should normally
378
+ # not need to pass this option.
379
+ # @return [String]
380
+ #
381
+ # @!attribute [rw] tags
382
+ # Key-value pairs to associate with the program management account.
383
+ # @return [Array<Types::Tag>]
384
+ #
385
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/CreateProgramManagementAccountRequest AWS API Documentation
386
+ #
387
+ class CreateProgramManagementAccountRequest < Struct.new(
388
+ :catalog,
389
+ :program,
390
+ :display_name,
391
+ :account_id,
392
+ :client_token,
393
+ :tags)
394
+ SENSITIVE = []
395
+ include Aws::Structure
396
+ end
397
+
398
+ # @!attribute [rw] program_management_account_detail
399
+ # Details of the created program management account.
400
+ # @return [Types::CreateProgramManagementAccountDetail]
401
+ #
402
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/CreateProgramManagementAccountResponse AWS API Documentation
403
+ #
404
+ class CreateProgramManagementAccountResponse < Struct.new(
405
+ :program_management_account_detail)
406
+ SENSITIVE = []
407
+ include Aws::Structure
408
+ end
409
+
410
+ # Contains details about a newly created relationship.
411
+ #
412
+ # @!attribute [rw] arn
413
+ # The Amazon Resource Name (ARN) of the created relationship.
414
+ # @return [String]
415
+ #
416
+ # @!attribute [rw] id
417
+ # The unique identifier of the created relationship.
418
+ # @return [String]
419
+ #
420
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/CreateRelationshipDetail AWS API Documentation
421
+ #
422
+ class CreateRelationshipDetail < Struct.new(
423
+ :arn,
424
+ :id)
425
+ SENSITIVE = []
426
+ include Aws::Structure
427
+ end
428
+
429
+ # @!attribute [rw] catalog
430
+ # The catalog identifier for the relationship.
431
+ # @return [String]
432
+ #
433
+ # @!attribute [rw] association_type
434
+ # The type of association for the relationship (e.g., reseller,
435
+ # distributor).
436
+ # @return [String]
437
+ #
438
+ # @!attribute [rw] program_management_account_identifier
439
+ # The identifier of the program management account for this
440
+ # relationship.
441
+ # @return [String]
442
+ #
443
+ # @!attribute [rw] associated_account_id
444
+ # The AWS account ID to associate in this relationship.
445
+ # @return [String]
446
+ #
447
+ # @!attribute [rw] display_name
448
+ # A human-readable name for the relationship.
449
+ # @return [String]
450
+ #
451
+ # @!attribute [rw] resale_account_model
452
+ # The resale account model for the relationship.
453
+ # @return [String]
454
+ #
455
+ # @!attribute [rw] sector
456
+ # The business sector for the relationship.
457
+ # @return [String]
458
+ #
459
+ # @!attribute [rw] client_token
460
+ # A unique, case-sensitive identifier to ensure idempotency of the
461
+ # request.
462
+ #
463
+ # **A suitable default value is auto-generated.** You should normally
464
+ # not need to pass this option.
465
+ # @return [String]
466
+ #
467
+ # @!attribute [rw] tags
468
+ # Key-value pairs to associate with the relationship.
469
+ # @return [Array<Types::Tag>]
470
+ #
471
+ # @!attribute [rw] requested_support_plan
472
+ # The support plan requested for this relationship.
473
+ # @return [Types::SupportPlan]
474
+ #
475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/CreateRelationshipRequest AWS API Documentation
476
+ #
477
+ class CreateRelationshipRequest < Struct.new(
478
+ :catalog,
479
+ :association_type,
480
+ :program_management_account_identifier,
481
+ :associated_account_id,
482
+ :display_name,
483
+ :resale_account_model,
484
+ :sector,
485
+ :client_token,
486
+ :tags,
487
+ :requested_support_plan)
488
+ SENSITIVE = []
489
+ include Aws::Structure
490
+ end
491
+
492
+ # @!attribute [rw] relationship_detail
493
+ # Details of the created relationship.
494
+ # @return [Types::CreateRelationshipDetail]
495
+ #
496
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/CreateRelationshipResponse AWS API Documentation
497
+ #
498
+ class CreateRelationshipResponse < Struct.new(
499
+ :relationship_detail)
500
+ SENSITIVE = []
501
+ include Aws::Structure
502
+ end
503
+
504
+ # @!attribute [rw] catalog
505
+ # The catalog identifier for the program management account.
506
+ # @return [String]
507
+ #
508
+ # @!attribute [rw] identifier
509
+ # The unique identifier of the program management account to delete.
510
+ # @return [String]
511
+ #
512
+ # @!attribute [rw] client_token
513
+ # A unique, case-sensitive identifier to ensure idempotency of the
514
+ # request.
515
+ #
516
+ # **A suitable default value is auto-generated.** You should normally
517
+ # not need to pass this option.
518
+ # @return [String]
519
+ #
520
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/DeleteProgramManagementAccountRequest AWS API Documentation
521
+ #
522
+ class DeleteProgramManagementAccountRequest < Struct.new(
523
+ :catalog,
524
+ :identifier,
525
+ :client_token)
526
+ SENSITIVE = []
527
+ include Aws::Structure
528
+ end
529
+
530
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/DeleteProgramManagementAccountResponse AWS API Documentation
531
+ #
532
+ class DeleteProgramManagementAccountResponse < Aws::EmptyStructure; end
533
+
534
+ # @!attribute [rw] catalog
535
+ # The catalog identifier for the relationship.
536
+ # @return [String]
537
+ #
538
+ # @!attribute [rw] identifier
539
+ # The unique identifier of the relationship to delete.
540
+ # @return [String]
541
+ #
542
+ # @!attribute [rw] program_management_account_identifier
543
+ # The identifier of the program management account associated with the
544
+ # relationship.
545
+ # @return [String]
546
+ #
547
+ # @!attribute [rw] client_token
548
+ # A unique, case-sensitive identifier to ensure idempotency of the
549
+ # request.
550
+ #
551
+ # **A suitable default value is auto-generated.** You should normally
552
+ # not need to pass this option.
553
+ # @return [String]
554
+ #
555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/DeleteRelationshipRequest AWS API Documentation
556
+ #
557
+ class DeleteRelationshipRequest < Struct.new(
558
+ :catalog,
559
+ :identifier,
560
+ :program_management_account_identifier,
561
+ :client_token)
562
+ SENSITIVE = []
563
+ include Aws::Structure
564
+ end
565
+
566
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/DeleteRelationshipResponse AWS API Documentation
567
+ #
568
+ class DeleteRelationshipResponse < Aws::EmptyStructure; end
569
+
570
+ # @!attribute [rw] catalog
571
+ # The catalog identifier for the relationship.
572
+ # @return [String]
573
+ #
574
+ # @!attribute [rw] program_management_account_identifier
575
+ # The identifier of the program management account associated with the
576
+ # relationship.
577
+ # @return [String]
578
+ #
579
+ # @!attribute [rw] identifier
580
+ # The unique identifier of the relationship to retrieve.
581
+ # @return [String]
582
+ #
583
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/GetRelationshipRequest AWS API Documentation
584
+ #
585
+ class GetRelationshipRequest < Struct.new(
586
+ :catalog,
587
+ :program_management_account_identifier,
588
+ :identifier)
589
+ SENSITIVE = []
590
+ include Aws::Structure
591
+ end
592
+
593
+ # @!attribute [rw] relationship_detail
594
+ # Details of the requested relationship.
595
+ # @return [Types::RelationshipDetail]
596
+ #
597
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/GetRelationshipResponse AWS API Documentation
598
+ #
599
+ class GetRelationshipResponse < Struct.new(
600
+ :relationship_detail)
601
+ SENSITIVE = []
602
+ include Aws::Structure
603
+ end
604
+
605
+ # Contains detailed information about different types of handshakes.
606
+ #
607
+ # @note HandshakeDetail is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of HandshakeDetail corresponding to the set member.
608
+ #
609
+ # @!attribute [rw] start_service_period_handshake_detail
610
+ # Details for a start service period handshake.
611
+ # @return [Types::StartServicePeriodHandshakeDetail]
612
+ #
613
+ # @!attribute [rw] revoke_service_period_handshake_detail
614
+ # Details for a revoke service period handshake.
615
+ # @return [Types::RevokeServicePeriodHandshakeDetail]
616
+ #
617
+ # @!attribute [rw] program_management_account_handshake_detail
618
+ # Details for a program management account handshake.
619
+ # @return [Types::ProgramManagementAccountHandshakeDetail]
620
+ #
621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/HandshakeDetail AWS API Documentation
622
+ #
623
+ class HandshakeDetail < Struct.new(
624
+ :start_service_period_handshake_detail,
625
+ :revoke_service_period_handshake_detail,
626
+ :program_management_account_handshake_detail,
627
+ :unknown)
628
+ SENSITIVE = []
629
+ include Aws::Structure
630
+ include Aws::Structure::Union
631
+
632
+ class StartServicePeriodHandshakeDetail < HandshakeDetail; end
633
+ class RevokeServicePeriodHandshakeDetail < HandshakeDetail; end
634
+ class ProgramManagementAccountHandshakeDetail < HandshakeDetail; end
635
+ class Unknown < HandshakeDetail; end
636
+ end
637
+
638
+ # An internal server error occurred while processing the request.
639
+ #
640
+ # @!attribute [rw] message
641
+ # A message describing the internal server error.
642
+ # @return [String]
643
+ #
644
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/InternalServerException AWS API Documentation
645
+ #
646
+ class InternalServerException < Struct.new(
647
+ :message)
648
+ SENSITIVE = []
649
+ include Aws::Structure
650
+ end
651
+
652
+ # @!attribute [rw] handshake_type
653
+ # Filter results by handshake type.
654
+ # @return [String]
655
+ #
656
+ # @!attribute [rw] catalog
657
+ # The catalog identifier to filter handshakes.
658
+ # @return [String]
659
+ #
660
+ # @!attribute [rw] participant_type
661
+ # Filter by participant type (sender or receiver).
662
+ # @return [String]
663
+ #
664
+ # @!attribute [rw] max_results
665
+ # The maximum number of results to return in a single call.
666
+ # @return [Integer]
667
+ #
668
+ # @!attribute [rw] statuses
669
+ # Filter results by handshake status.
670
+ # @return [Array<String>]
671
+ #
672
+ # @!attribute [rw] associated_resource_identifiers
673
+ # Filter by associated resource identifiers.
674
+ # @return [Array<String>]
675
+ #
676
+ # @!attribute [rw] handshake_type_filters
677
+ # Type-specific filters for handshakes.
678
+ # @return [Types::ListChannelHandshakesTypeFilters]
679
+ #
680
+ # @!attribute [rw] handshake_type_sort
681
+ # Type-specific sorting options for handshakes.
682
+ # @return [Types::ListChannelHandshakesTypeSort]
683
+ #
684
+ # @!attribute [rw] next_token
685
+ # Token for retrieving the next page of results.
686
+ # @return [String]
687
+ #
688
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ListChannelHandshakesRequest AWS API Documentation
689
+ #
690
+ class ListChannelHandshakesRequest < Struct.new(
691
+ :handshake_type,
692
+ :catalog,
693
+ :participant_type,
694
+ :max_results,
695
+ :statuses,
696
+ :associated_resource_identifiers,
697
+ :handshake_type_filters,
698
+ :handshake_type_sort,
699
+ :next_token)
700
+ SENSITIVE = []
701
+ include Aws::Structure
702
+ end
703
+
704
+ # @!attribute [rw] items
705
+ # List of channel handshakes matching the criteria.
706
+ # @return [Array<Types::ChannelHandshakeSummary>]
707
+ #
708
+ # @!attribute [rw] next_token
709
+ # Token for retrieving the next page of results, if available.
710
+ # @return [String]
711
+ #
712
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ListChannelHandshakesResponse AWS API Documentation
713
+ #
714
+ class ListChannelHandshakesResponse < Struct.new(
715
+ :items,
716
+ :next_token)
717
+ SENSITIVE = []
718
+ include Aws::Structure
719
+ end
720
+
721
+ # Type-specific filters for listing channel handshakes.
722
+ #
723
+ # @note ListChannelHandshakesTypeFilters is a union - when making an API calls you must set exactly one of the members.
724
+ #
725
+ # @!attribute [rw] start_service_period_type_filters
726
+ # Filters specific to start service period handshakes.
727
+ # @return [Types::StartServicePeriodTypeFilters]
728
+ #
729
+ # @!attribute [rw] revoke_service_period_type_filters
730
+ # Filters specific to revoke service period handshakes.
731
+ # @return [Types::RevokeServicePeriodTypeFilters]
732
+ #
733
+ # @!attribute [rw] program_management_account_type_filters
734
+ # Filters specific to program management account handshakes.
735
+ # @return [Types::ProgramManagementAccountTypeFilters]
736
+ #
737
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ListChannelHandshakesTypeFilters AWS API Documentation
738
+ #
739
+ class ListChannelHandshakesTypeFilters < Struct.new(
740
+ :start_service_period_type_filters,
741
+ :revoke_service_period_type_filters,
742
+ :program_management_account_type_filters,
743
+ :unknown)
744
+ SENSITIVE = []
745
+ include Aws::Structure
746
+ include Aws::Structure::Union
747
+
748
+ class StartServicePeriodTypeFilters < ListChannelHandshakesTypeFilters; end
749
+ class RevokeServicePeriodTypeFilters < ListChannelHandshakesTypeFilters; end
750
+ class ProgramManagementAccountTypeFilters < ListChannelHandshakesTypeFilters; end
751
+ class Unknown < ListChannelHandshakesTypeFilters; end
752
+ end
753
+
754
+ # Type-specific sorting options for listing channel handshakes.
755
+ #
756
+ # @note ListChannelHandshakesTypeSort is a union - when making an API calls you must set exactly one of the members.
757
+ #
758
+ # @!attribute [rw] start_service_period_type_sort
759
+ # Sorting options specific to start service period handshakes.
760
+ # @return [Types::StartServicePeriodTypeSort]
761
+ #
762
+ # @!attribute [rw] revoke_service_period_type_sort
763
+ # Sorting options specific to revoke service period handshakes.
764
+ # @return [Types::RevokeServicePeriodTypeSort]
765
+ #
766
+ # @!attribute [rw] program_management_account_type_sort
767
+ # Sorting options specific to program management account handshakes.
768
+ # @return [Types::ProgramManagementAccountTypeSort]
769
+ #
770
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ListChannelHandshakesTypeSort AWS API Documentation
771
+ #
772
+ class ListChannelHandshakesTypeSort < Struct.new(
773
+ :start_service_period_type_sort,
774
+ :revoke_service_period_type_sort,
775
+ :program_management_account_type_sort,
776
+ :unknown)
777
+ SENSITIVE = []
778
+ include Aws::Structure
779
+ include Aws::Structure::Union
780
+
781
+ class StartServicePeriodTypeSort < ListChannelHandshakesTypeSort; end
782
+ class RevokeServicePeriodTypeSort < ListChannelHandshakesTypeSort; end
783
+ class ProgramManagementAccountTypeSort < ListChannelHandshakesTypeSort; end
784
+ class Unknown < ListChannelHandshakesTypeSort; end
785
+ end
786
+
787
+ # @!attribute [rw] catalog
788
+ # The catalog identifier to filter accounts.
789
+ # @return [String]
790
+ #
791
+ # @!attribute [rw] max_results
792
+ # The maximum number of results to return in a single call.
793
+ # @return [Integer]
794
+ #
795
+ # @!attribute [rw] display_names
796
+ # Filter by display names.
797
+ # @return [Array<String>]
798
+ #
799
+ # @!attribute [rw] programs
800
+ # Filter by program types.
801
+ # @return [Array<String>]
802
+ #
803
+ # @!attribute [rw] account_ids
804
+ # Filter by AWS account IDs.
805
+ # @return [Array<String>]
806
+ #
807
+ # @!attribute [rw] statuses
808
+ # Filter by program management account statuses.
809
+ # @return [Array<String>]
810
+ #
811
+ # @!attribute [rw] sort
812
+ # Sorting options for the results.
813
+ # @return [Types::ListProgramManagementAccountsSortBase]
814
+ #
815
+ # @!attribute [rw] next_token
816
+ # Token for retrieving the next page of results.
817
+ # @return [String]
818
+ #
819
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ListProgramManagementAccountsRequest AWS API Documentation
820
+ #
821
+ class ListProgramManagementAccountsRequest < Struct.new(
822
+ :catalog,
823
+ :max_results,
824
+ :display_names,
825
+ :programs,
826
+ :account_ids,
827
+ :statuses,
828
+ :sort,
829
+ :next_token)
830
+ SENSITIVE = []
831
+ include Aws::Structure
832
+ end
833
+
834
+ # @!attribute [rw] items
835
+ # List of program management accounts matching the criteria.
836
+ # @return [Array<Types::ProgramManagementAccountSummary>]
837
+ #
838
+ # @!attribute [rw] next_token
839
+ # Token for retrieving the next page of results, if available.
840
+ # @return [String]
841
+ #
842
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ListProgramManagementAccountsResponse AWS API Documentation
843
+ #
844
+ class ListProgramManagementAccountsResponse < Struct.new(
845
+ :items,
846
+ :next_token)
847
+ SENSITIVE = []
848
+ include Aws::Structure
849
+ end
850
+
851
+ # Base sorting configuration for program management accounts.
852
+ #
853
+ # @!attribute [rw] sort_order
854
+ # The sort order (ascending or descending).
855
+ # @return [String]
856
+ #
857
+ # @!attribute [rw] sort_by
858
+ # The field to sort by.
859
+ # @return [String]
860
+ #
861
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ListProgramManagementAccountsSortBase AWS API Documentation
862
+ #
863
+ class ListProgramManagementAccountsSortBase < Struct.new(
864
+ :sort_order,
865
+ :sort_by)
866
+ SENSITIVE = []
867
+ include Aws::Structure
868
+ end
869
+
870
+ # @!attribute [rw] catalog
871
+ # The catalog identifier to filter relationships.
872
+ # @return [String]
873
+ #
874
+ # @!attribute [rw] max_results
875
+ # The maximum number of results to return in a single call.
876
+ # @return [Integer]
877
+ #
878
+ # @!attribute [rw] associated_account_ids
879
+ # Filter by associated AWS account IDs.
880
+ # @return [Array<String>]
881
+ #
882
+ # @!attribute [rw] association_types
883
+ # Filter by association types.
884
+ # @return [Array<String>]
885
+ #
886
+ # @!attribute [rw] display_names
887
+ # Filter by display names.
888
+ # @return [Array<String>]
889
+ #
890
+ # @!attribute [rw] program_management_account_identifiers
891
+ # Filter by program management account identifiers.
892
+ # @return [Array<String>]
893
+ #
894
+ # @!attribute [rw] sort
895
+ # Sorting options for the results.
896
+ # @return [Types::ListRelationshipsSortBase]
897
+ #
898
+ # @!attribute [rw] next_token
899
+ # Token for retrieving the next page of results.
900
+ # @return [String]
901
+ #
902
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ListRelationshipsRequest AWS API Documentation
903
+ #
904
+ class ListRelationshipsRequest < Struct.new(
905
+ :catalog,
906
+ :max_results,
907
+ :associated_account_ids,
908
+ :association_types,
909
+ :display_names,
910
+ :program_management_account_identifiers,
911
+ :sort,
912
+ :next_token)
913
+ SENSITIVE = []
914
+ include Aws::Structure
915
+ end
916
+
917
+ # @!attribute [rw] items
918
+ # List of relationships matching the criteria.
919
+ # @return [Array<Types::RelationshipSummary>]
920
+ #
921
+ # @!attribute [rw] next_token
922
+ # Token for retrieving the next page of results, if available.
923
+ # @return [String]
924
+ #
925
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ListRelationshipsResponse AWS API Documentation
926
+ #
927
+ class ListRelationshipsResponse < Struct.new(
928
+ :items,
929
+ :next_token)
930
+ SENSITIVE = []
931
+ include Aws::Structure
932
+ end
933
+
934
+ # Base sorting configuration for relationships.
935
+ #
936
+ # @!attribute [rw] sort_order
937
+ # The sort order (ascending or descending).
938
+ # @return [String]
939
+ #
940
+ # @!attribute [rw] sort_by
941
+ # The field to sort by.
942
+ # @return [String]
943
+ #
944
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ListRelationshipsSortBase AWS API Documentation
945
+ #
946
+ class ListRelationshipsSortBase < Struct.new(
947
+ :sort_order,
948
+ :sort_by)
949
+ SENSITIVE = []
950
+ include Aws::Structure
951
+ end
952
+
953
+ # @!attribute [rw] resource_arn
954
+ # The Amazon Resource Name (ARN) of the resource to list tags for.
955
+ # @return [String]
956
+ #
957
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ListTagsForResourceRequest AWS API Documentation
958
+ #
959
+ class ListTagsForResourceRequest < Struct.new(
960
+ :resource_arn)
961
+ SENSITIVE = []
962
+ include Aws::Structure
963
+ end
964
+
965
+ # @!attribute [rw] tags
966
+ # Key-value pairs associated with the resource.
967
+ # @return [Array<Types::Tag>]
968
+ #
969
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ListTagsForResourceResponse AWS API Documentation
970
+ #
971
+ class ListTagsForResourceResponse < Struct.new(
972
+ :tags)
973
+ SENSITIVE = []
974
+ include Aws::Structure
975
+ end
976
+
977
+ # Configuration for partner-led support plans.
978
+ #
979
+ # @!attribute [rw] coverage
980
+ # The coverage level for partner-led support.
981
+ # @return [String]
982
+ #
983
+ # @!attribute [rw] provider
984
+ # The provider of the partner-led support.
985
+ # @return [String]
986
+ #
987
+ # @!attribute [rw] tam_location
988
+ # The location of the Technical Account Manager (TAM).
989
+ # @return [String]
990
+ #
991
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/PartnerLedSupport AWS API Documentation
992
+ #
993
+ class PartnerLedSupport < Struct.new(
994
+ :coverage,
995
+ :provider,
996
+ :tam_location)
997
+ SENSITIVE = []
998
+ include Aws::Structure
999
+ end
1000
+
1001
+ # Details specific to program management account handshakes.
1002
+ #
1003
+ # @!attribute [rw] program
1004
+ # The program associated with the handshake.
1005
+ # @return [String]
1006
+ #
1007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ProgramManagementAccountHandshakeDetail AWS API Documentation
1008
+ #
1009
+ class ProgramManagementAccountHandshakeDetail < Struct.new(
1010
+ :program)
1011
+ SENSITIVE = []
1012
+ include Aws::Structure
1013
+ end
1014
+
1015
+ # Summary information about a program management account.
1016
+ #
1017
+ # @!attribute [rw] id
1018
+ # The unique identifier of the program management account.
1019
+ # @return [String]
1020
+ #
1021
+ # @!attribute [rw] revision
1022
+ # The current revision number of the program management account.
1023
+ # @return [String]
1024
+ #
1025
+ # @!attribute [rw] catalog
1026
+ # The catalog identifier associated with the account.
1027
+ # @return [String]
1028
+ #
1029
+ # @!attribute [rw] program
1030
+ # The program type for the management account.
1031
+ # @return [String]
1032
+ #
1033
+ # @!attribute [rw] display_name
1034
+ # The display name of the program management account.
1035
+ # @return [String]
1036
+ #
1037
+ # @!attribute [rw] account_id
1038
+ # The AWS account ID associated with the program management account.
1039
+ # @return [String]
1040
+ #
1041
+ # @!attribute [rw] arn
1042
+ # The Amazon Resource Name (ARN) of the program management account.
1043
+ # @return [String]
1044
+ #
1045
+ # @!attribute [rw] created_at
1046
+ # The timestamp when the account was created.
1047
+ # @return [Time]
1048
+ #
1049
+ # @!attribute [rw] updated_at
1050
+ # The timestamp when the account was last updated.
1051
+ # @return [Time]
1052
+ #
1053
+ # @!attribute [rw] start_date
1054
+ # The start date of the program management account.
1055
+ # @return [Time]
1056
+ #
1057
+ # @!attribute [rw] status
1058
+ # The current status of the program management account.
1059
+ # @return [String]
1060
+ #
1061
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ProgramManagementAccountSummary AWS API Documentation
1062
+ #
1063
+ class ProgramManagementAccountSummary < Struct.new(
1064
+ :id,
1065
+ :revision,
1066
+ :catalog,
1067
+ :program,
1068
+ :display_name,
1069
+ :account_id,
1070
+ :arn,
1071
+ :created_at,
1072
+ :updated_at,
1073
+ :start_date,
1074
+ :status)
1075
+ SENSITIVE = []
1076
+ include Aws::Structure
1077
+ end
1078
+
1079
+ # Type-specific filters for program management accounts.
1080
+ #
1081
+ # @!attribute [rw] programs
1082
+ # Filter by program types.
1083
+ # @return [Array<String>]
1084
+ #
1085
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ProgramManagementAccountTypeFilters AWS API Documentation
1086
+ #
1087
+ class ProgramManagementAccountTypeFilters < Struct.new(
1088
+ :programs)
1089
+ SENSITIVE = []
1090
+ include Aws::Structure
1091
+ end
1092
+
1093
+ # Type-specific sorting options for program management accounts.
1094
+ #
1095
+ # @!attribute [rw] sort_order
1096
+ # The sort order (ascending or descending).
1097
+ # @return [String]
1098
+ #
1099
+ # @!attribute [rw] sort_by
1100
+ # The field to sort by.
1101
+ # @return [String]
1102
+ #
1103
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ProgramManagementAccountTypeSort AWS API Documentation
1104
+ #
1105
+ class ProgramManagementAccountTypeSort < Struct.new(
1106
+ :sort_order,
1107
+ :sort_by)
1108
+ SENSITIVE = []
1109
+ include Aws::Structure
1110
+ end
1111
+
1112
+ # Contains details about a rejected channel handshake.
1113
+ #
1114
+ # @!attribute [rw] id
1115
+ # The unique identifier of the rejected handshake.
1116
+ # @return [String]
1117
+ #
1118
+ # @!attribute [rw] arn
1119
+ # The Amazon Resource Name (ARN) of the rejected handshake.
1120
+ # @return [String]
1121
+ #
1122
+ # @!attribute [rw] status
1123
+ # The current status of the rejected handshake.
1124
+ # @return [String]
1125
+ #
1126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/RejectChannelHandshakeDetail AWS API Documentation
1127
+ #
1128
+ class RejectChannelHandshakeDetail < Struct.new(
1129
+ :id,
1130
+ :arn,
1131
+ :status)
1132
+ SENSITIVE = []
1133
+ include Aws::Structure
1134
+ end
1135
+
1136
+ # @!attribute [rw] catalog
1137
+ # The catalog identifier for the handshake request.
1138
+ # @return [String]
1139
+ #
1140
+ # @!attribute [rw] identifier
1141
+ # The unique identifier of the channel handshake to reject.
1142
+ # @return [String]
1143
+ #
1144
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/RejectChannelHandshakeRequest AWS API Documentation
1145
+ #
1146
+ class RejectChannelHandshakeRequest < Struct.new(
1147
+ :catalog,
1148
+ :identifier)
1149
+ SENSITIVE = []
1150
+ include Aws::Structure
1151
+ end
1152
+
1153
+ # @!attribute [rw] channel_handshake_detail
1154
+ # Details of the rejected channel handshake.
1155
+ # @return [Types::RejectChannelHandshakeDetail]
1156
+ #
1157
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/RejectChannelHandshakeResponse AWS API Documentation
1158
+ #
1159
+ class RejectChannelHandshakeResponse < Struct.new(
1160
+ :channel_handshake_detail)
1161
+ SENSITIVE = []
1162
+ include Aws::Structure
1163
+ end
1164
+
1165
+ # Detailed information about a partner relationship.
1166
+ #
1167
+ # @!attribute [rw] arn
1168
+ # The Amazon Resource Name (ARN) of the relationship.
1169
+ # @return [String]
1170
+ #
1171
+ # @!attribute [rw] id
1172
+ # The unique identifier of the relationship.
1173
+ # @return [String]
1174
+ #
1175
+ # @!attribute [rw] revision
1176
+ # The current revision number of the relationship.
1177
+ # @return [String]
1178
+ #
1179
+ # @!attribute [rw] catalog
1180
+ # The catalog identifier associated with the relationship.
1181
+ # @return [String]
1182
+ #
1183
+ # @!attribute [rw] association_type
1184
+ # The type of association for the relationship.
1185
+ # @return [String]
1186
+ #
1187
+ # @!attribute [rw] program_management_account_id
1188
+ # The identifier of the program management account.
1189
+ # @return [String]
1190
+ #
1191
+ # @!attribute [rw] associated_account_id
1192
+ # The AWS account ID associated in this relationship.
1193
+ # @return [String]
1194
+ #
1195
+ # @!attribute [rw] display_name
1196
+ # The display name of the relationship.
1197
+ # @return [String]
1198
+ #
1199
+ # @!attribute [rw] resale_account_model
1200
+ # The resale account model for the relationship.
1201
+ # @return [String]
1202
+ #
1203
+ # @!attribute [rw] sector
1204
+ # The business sector for the relationship.
1205
+ # @return [String]
1206
+ #
1207
+ # @!attribute [rw] created_at
1208
+ # The timestamp when the relationship was created.
1209
+ # @return [Time]
1210
+ #
1211
+ # @!attribute [rw] updated_at
1212
+ # The timestamp when the relationship was last updated.
1213
+ # @return [Time]
1214
+ #
1215
+ # @!attribute [rw] start_date
1216
+ # The start date of the relationship.
1217
+ # @return [Time]
1218
+ #
1219
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/RelationshipDetail AWS API Documentation
1220
+ #
1221
+ class RelationshipDetail < Struct.new(
1222
+ :arn,
1223
+ :id,
1224
+ :revision,
1225
+ :catalog,
1226
+ :association_type,
1227
+ :program_management_account_id,
1228
+ :associated_account_id,
1229
+ :display_name,
1230
+ :resale_account_model,
1231
+ :sector,
1232
+ :created_at,
1233
+ :updated_at,
1234
+ :start_date)
1235
+ SENSITIVE = []
1236
+ include Aws::Structure
1237
+ end
1238
+
1239
+ # Summary information about a partner relationship.
1240
+ #
1241
+ # @!attribute [rw] arn
1242
+ # The Amazon Resource Name (ARN) of the relationship.
1243
+ # @return [String]
1244
+ #
1245
+ # @!attribute [rw] id
1246
+ # The unique identifier of the relationship.
1247
+ # @return [String]
1248
+ #
1249
+ # @!attribute [rw] revision
1250
+ # The current revision number of the relationship.
1251
+ # @return [String]
1252
+ #
1253
+ # @!attribute [rw] catalog
1254
+ # The catalog identifier associated with the relationship.
1255
+ # @return [String]
1256
+ #
1257
+ # @!attribute [rw] association_type
1258
+ # The type of association for the relationship.
1259
+ # @return [String]
1260
+ #
1261
+ # @!attribute [rw] program_management_account_id
1262
+ # The identifier of the program management account.
1263
+ # @return [String]
1264
+ #
1265
+ # @!attribute [rw] associated_account_id
1266
+ # The AWS account ID associated in this relationship.
1267
+ # @return [String]
1268
+ #
1269
+ # @!attribute [rw] display_name
1270
+ # The display name of the relationship.
1271
+ # @return [String]
1272
+ #
1273
+ # @!attribute [rw] sector
1274
+ # The business sector for the relationship.
1275
+ # @return [String]
1276
+ #
1277
+ # @!attribute [rw] created_at
1278
+ # The timestamp when the relationship was created.
1279
+ # @return [Time]
1280
+ #
1281
+ # @!attribute [rw] updated_at
1282
+ # The timestamp when the relationship was last updated.
1283
+ # @return [Time]
1284
+ #
1285
+ # @!attribute [rw] start_date
1286
+ # The start date of the relationship.
1287
+ # @return [Time]
1288
+ #
1289
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/RelationshipSummary AWS API Documentation
1290
+ #
1291
+ class RelationshipSummary < Struct.new(
1292
+ :arn,
1293
+ :id,
1294
+ :revision,
1295
+ :catalog,
1296
+ :association_type,
1297
+ :program_management_account_id,
1298
+ :associated_account_id,
1299
+ :display_name,
1300
+ :sector,
1301
+ :created_at,
1302
+ :updated_at,
1303
+ :start_date)
1304
+ SENSITIVE = []
1305
+ include Aws::Structure
1306
+ end
1307
+
1308
+ # Configuration for resold business support plans.
1309
+ #
1310
+ # @!attribute [rw] coverage
1311
+ # The coverage level for resold business support.
1312
+ # @return [String]
1313
+ #
1314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ResoldBusiness AWS API Documentation
1315
+ #
1316
+ class ResoldBusiness < Struct.new(
1317
+ :coverage)
1318
+ SENSITIVE = []
1319
+ include Aws::Structure
1320
+ end
1321
+
1322
+ # Configuration for resold enterprise support plans.
1323
+ #
1324
+ # @!attribute [rw] coverage
1325
+ # The coverage level for resold enterprise support.
1326
+ # @return [String]
1327
+ #
1328
+ # @!attribute [rw] tam_location
1329
+ # The location of the Technical Account Manager (TAM).
1330
+ # @return [String]
1331
+ #
1332
+ # @!attribute [rw] charge_account_id
1333
+ # The AWS account ID to charge for the support plan.
1334
+ # @return [String]
1335
+ #
1336
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ResoldEnterprise AWS API Documentation
1337
+ #
1338
+ class ResoldEnterprise < Struct.new(
1339
+ :coverage,
1340
+ :tam_location,
1341
+ :charge_account_id)
1342
+ SENSITIVE = []
1343
+ include Aws::Structure
1344
+ end
1345
+
1346
+ # The specified resource was not found.
1347
+ #
1348
+ # @!attribute [rw] message
1349
+ # A message describing the resource not found error.
1350
+ # @return [String]
1351
+ #
1352
+ # @!attribute [rw] resource_id
1353
+ # The identifier of the resource that was not found.
1354
+ # @return [String]
1355
+ #
1356
+ # @!attribute [rw] resource_type
1357
+ # The type of the resource that was not found.
1358
+ # @return [String]
1359
+ #
1360
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ResourceNotFoundException AWS API Documentation
1361
+ #
1362
+ class ResourceNotFoundException < Struct.new(
1363
+ :message,
1364
+ :resource_id,
1365
+ :resource_type)
1366
+ SENSITIVE = []
1367
+ include Aws::Structure
1368
+ end
1369
+
1370
+ # Details specific to revoke service period handshakes.
1371
+ #
1372
+ # @!attribute [rw] note
1373
+ # A note explaining the reason for revoking the service period.
1374
+ # @return [String]
1375
+ #
1376
+ # @!attribute [rw] service_period_type
1377
+ # The type of service period being revoked.
1378
+ # @return [String]
1379
+ #
1380
+ # @!attribute [rw] minimum_notice_days
1381
+ # The minimum number of days notice required for revocation.
1382
+ # @return [String]
1383
+ #
1384
+ # @!attribute [rw] start_date
1385
+ # The start date of the service period being revoked.
1386
+ # @return [Time]
1387
+ #
1388
+ # @!attribute [rw] end_date
1389
+ # The end date of the service period being revoked.
1390
+ # @return [Time]
1391
+ #
1392
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/RevokeServicePeriodHandshakeDetail AWS API Documentation
1393
+ #
1394
+ class RevokeServicePeriodHandshakeDetail < Struct.new(
1395
+ :note,
1396
+ :service_period_type,
1397
+ :minimum_notice_days,
1398
+ :start_date,
1399
+ :end_date)
1400
+ SENSITIVE = []
1401
+ include Aws::Structure
1402
+ end
1403
+
1404
+ # Payload for revoke service period handshake requests.
1405
+ #
1406
+ # @!attribute [rw] program_management_account_identifier
1407
+ # The identifier of the program management account.
1408
+ # @return [String]
1409
+ #
1410
+ # @!attribute [rw] note
1411
+ # A note explaining the reason for revoking the service period.
1412
+ # @return [String]
1413
+ #
1414
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/RevokeServicePeriodPayload AWS API Documentation
1415
+ #
1416
+ class RevokeServicePeriodPayload < Struct.new(
1417
+ :program_management_account_identifier,
1418
+ :note)
1419
+ SENSITIVE = []
1420
+ include Aws::Structure
1421
+ end
1422
+
1423
+ # Filters specific to revoke service period handshakes.
1424
+ #
1425
+ # @!attribute [rw] service_period_types
1426
+ # Filter by service period types.
1427
+ # @return [Array<String>]
1428
+ #
1429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/RevokeServicePeriodTypeFilters AWS API Documentation
1430
+ #
1431
+ class RevokeServicePeriodTypeFilters < Struct.new(
1432
+ :service_period_types)
1433
+ SENSITIVE = []
1434
+ include Aws::Structure
1435
+ end
1436
+
1437
+ # Sorting options specific to revoke service period handshakes.
1438
+ #
1439
+ # @!attribute [rw] sort_order
1440
+ # The sort order (ascending or descending).
1441
+ # @return [String]
1442
+ #
1443
+ # @!attribute [rw] sort_by
1444
+ # The field to sort by.
1445
+ # @return [String]
1446
+ #
1447
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/RevokeServicePeriodTypeSort AWS API Documentation
1448
+ #
1449
+ class RevokeServicePeriodTypeSort < Struct.new(
1450
+ :sort_order,
1451
+ :sort_by)
1452
+ SENSITIVE = []
1453
+ include Aws::Structure
1454
+ end
1455
+
1456
+ # The request would exceed a service quota limit.
1457
+ #
1458
+ # @!attribute [rw] message
1459
+ # A message describing the service quota exceeded error.
1460
+ # @return [String]
1461
+ #
1462
+ # @!attribute [rw] resource_id
1463
+ # The identifier of the resource that would exceed the quota.
1464
+ # @return [String]
1465
+ #
1466
+ # @!attribute [rw] resource_type
1467
+ # The type of the resource that would exceed the quota.
1468
+ # @return [String]
1469
+ #
1470
+ # @!attribute [rw] quota_code
1471
+ # The code identifying the specific quota that would be exceeded.
1472
+ # @return [String]
1473
+ #
1474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ServiceQuotaExceededException AWS API Documentation
1475
+ #
1476
+ class ServiceQuotaExceededException < Struct.new(
1477
+ :message,
1478
+ :resource_id,
1479
+ :resource_type,
1480
+ :quota_code)
1481
+ SENSITIVE = []
1482
+ include Aws::Structure
1483
+ end
1484
+
1485
+ # Details specific to start service period handshakes.
1486
+ #
1487
+ # @!attribute [rw] note
1488
+ # A note providing additional information about the service period.
1489
+ # @return [String]
1490
+ #
1491
+ # @!attribute [rw] service_period_type
1492
+ # The type of service period being started.
1493
+ # @return [String]
1494
+ #
1495
+ # @!attribute [rw] minimum_notice_days
1496
+ # The minimum number of days notice required for changes.
1497
+ # @return [String]
1498
+ #
1499
+ # @!attribute [rw] start_date
1500
+ # The start date of the service period.
1501
+ # @return [Time]
1502
+ #
1503
+ # @!attribute [rw] end_date
1504
+ # The end date of the service period.
1505
+ # @return [Time]
1506
+ #
1507
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/StartServicePeriodHandshakeDetail AWS API Documentation
1508
+ #
1509
+ class StartServicePeriodHandshakeDetail < Struct.new(
1510
+ :note,
1511
+ :service_period_type,
1512
+ :minimum_notice_days,
1513
+ :start_date,
1514
+ :end_date)
1515
+ SENSITIVE = []
1516
+ include Aws::Structure
1517
+ end
1518
+
1519
+ # Payload for start service period handshake requests.
1520
+ #
1521
+ # @!attribute [rw] program_management_account_identifier
1522
+ # The identifier of the program management account.
1523
+ # @return [String]
1524
+ #
1525
+ # @!attribute [rw] note
1526
+ # A note providing additional information about the service period.
1527
+ # @return [String]
1528
+ #
1529
+ # @!attribute [rw] service_period_type
1530
+ # The type of service period being started.
1531
+ # @return [String]
1532
+ #
1533
+ # @!attribute [rw] minimum_notice_days
1534
+ # The minimum number of days notice required for changes.
1535
+ # @return [String]
1536
+ #
1537
+ # @!attribute [rw] end_date
1538
+ # The end date of the service period.
1539
+ # @return [Time]
1540
+ #
1541
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/StartServicePeriodPayload AWS API Documentation
1542
+ #
1543
+ class StartServicePeriodPayload < Struct.new(
1544
+ :program_management_account_identifier,
1545
+ :note,
1546
+ :service_period_type,
1547
+ :minimum_notice_days,
1548
+ :end_date)
1549
+ SENSITIVE = []
1550
+ include Aws::Structure
1551
+ end
1552
+
1553
+ # Filters specific to start service period handshakes.
1554
+ #
1555
+ # @!attribute [rw] service_period_types
1556
+ # Filter by service period types.
1557
+ # @return [Array<String>]
1558
+ #
1559
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/StartServicePeriodTypeFilters AWS API Documentation
1560
+ #
1561
+ class StartServicePeriodTypeFilters < Struct.new(
1562
+ :service_period_types)
1563
+ SENSITIVE = []
1564
+ include Aws::Structure
1565
+ end
1566
+
1567
+ # Sorting options specific to start service period handshakes.
1568
+ #
1569
+ # @!attribute [rw] sort_order
1570
+ # The sort order (ascending or descending).
1571
+ # @return [String]
1572
+ #
1573
+ # @!attribute [rw] sort_by
1574
+ # The field to sort by.
1575
+ # @return [String]
1576
+ #
1577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/StartServicePeriodTypeSort AWS API Documentation
1578
+ #
1579
+ class StartServicePeriodTypeSort < Struct.new(
1580
+ :sort_order,
1581
+ :sort_by)
1582
+ SENSITIVE = []
1583
+ include Aws::Structure
1584
+ end
1585
+
1586
+ # Configuration for different types of support plans.
1587
+ #
1588
+ # @note SupportPlan is a union - when making an API calls you must set exactly one of the members.
1589
+ #
1590
+ # @!attribute [rw] resold_business
1591
+ # Configuration for resold business support plans.
1592
+ # @return [Types::ResoldBusiness]
1593
+ #
1594
+ # @!attribute [rw] resold_enterprise
1595
+ # Configuration for resold enterprise support plans.
1596
+ # @return [Types::ResoldEnterprise]
1597
+ #
1598
+ # @!attribute [rw] partner_led_support
1599
+ # Configuration for partner-led support plans.
1600
+ # @return [Types::PartnerLedSupport]
1601
+ #
1602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/SupportPlan AWS API Documentation
1603
+ #
1604
+ class SupportPlan < Struct.new(
1605
+ :resold_business,
1606
+ :resold_enterprise,
1607
+ :partner_led_support,
1608
+ :unknown)
1609
+ SENSITIVE = []
1610
+ include Aws::Structure
1611
+ include Aws::Structure::Union
1612
+
1613
+ class ResoldBusiness < SupportPlan; end
1614
+ class ResoldEnterprise < SupportPlan; end
1615
+ class PartnerLedSupport < SupportPlan; end
1616
+ class Unknown < SupportPlan; end
1617
+ end
1618
+
1619
+ # A key-value pair that can be associated with a resource.
1620
+ #
1621
+ # @!attribute [rw] key
1622
+ # The key of the tag.
1623
+ # @return [String]
1624
+ #
1625
+ # @!attribute [rw] value
1626
+ # The value of the tag.
1627
+ # @return [String]
1628
+ #
1629
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/Tag AWS API Documentation
1630
+ #
1631
+ class Tag < Struct.new(
1632
+ :key,
1633
+ :value)
1634
+ SENSITIVE = []
1635
+ include Aws::Structure
1636
+ end
1637
+
1638
+ # @!attribute [rw] resource_arn
1639
+ # The Amazon Resource Name (ARN) of the resource to tag.
1640
+ # @return [String]
1641
+ #
1642
+ # @!attribute [rw] tags
1643
+ # Key-value pairs to associate with the resource.
1644
+ # @return [Array<Types::Tag>]
1645
+ #
1646
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/TagResourceRequest AWS API Documentation
1647
+ #
1648
+ class TagResourceRequest < Struct.new(
1649
+ :resource_arn,
1650
+ :tags)
1651
+ SENSITIVE = []
1652
+ include Aws::Structure
1653
+ end
1654
+
1655
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/TagResourceResponse AWS API Documentation
1656
+ #
1657
+ class TagResourceResponse < Aws::EmptyStructure; end
1658
+
1659
+ # The request was throttled due to too many requests being sent in a
1660
+ # short period.
1661
+ #
1662
+ # @!attribute [rw] message
1663
+ # A message describing the throttling error.
1664
+ # @return [String]
1665
+ #
1666
+ # @!attribute [rw] service_code
1667
+ # The service code associated with the throttling error.
1668
+ # @return [String]
1669
+ #
1670
+ # @!attribute [rw] quota_code
1671
+ # The quota code associated with the throttling error.
1672
+ # @return [String]
1673
+ #
1674
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ThrottlingException AWS API Documentation
1675
+ #
1676
+ class ThrottlingException < Struct.new(
1677
+ :message,
1678
+ :service_code,
1679
+ :quota_code)
1680
+ SENSITIVE = []
1681
+ include Aws::Structure
1682
+ end
1683
+
1684
+ # @!attribute [rw] resource_arn
1685
+ # The Amazon Resource Name (ARN) of the resource to remove tags from.
1686
+ # @return [String]
1687
+ #
1688
+ # @!attribute [rw] tag_keys
1689
+ # The keys of the tags to remove from the resource.
1690
+ # @return [Array<String>]
1691
+ #
1692
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/UntagResourceRequest AWS API Documentation
1693
+ #
1694
+ class UntagResourceRequest < Struct.new(
1695
+ :resource_arn,
1696
+ :tag_keys)
1697
+ SENSITIVE = []
1698
+ include Aws::Structure
1699
+ end
1700
+
1701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/UntagResourceResponse AWS API Documentation
1702
+ #
1703
+ class UntagResourceResponse < Aws::EmptyStructure; end
1704
+
1705
+ # Contains details about an updated program management account.
1706
+ #
1707
+ # @!attribute [rw] id
1708
+ # The unique identifier of the updated program management account.
1709
+ # @return [String]
1710
+ #
1711
+ # @!attribute [rw] arn
1712
+ # The Amazon Resource Name (ARN) of the updated program management
1713
+ # account.
1714
+ # @return [String]
1715
+ #
1716
+ # @!attribute [rw] revision
1717
+ # The new revision number of the program management account.
1718
+ # @return [String]
1719
+ #
1720
+ # @!attribute [rw] display_name
1721
+ # The updated display name of the program management account.
1722
+ # @return [String]
1723
+ #
1724
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/UpdateProgramManagementAccountDetail AWS API Documentation
1725
+ #
1726
+ class UpdateProgramManagementAccountDetail < Struct.new(
1727
+ :id,
1728
+ :arn,
1729
+ :revision,
1730
+ :display_name)
1731
+ SENSITIVE = []
1732
+ include Aws::Structure
1733
+ end
1734
+
1735
+ # @!attribute [rw] catalog
1736
+ # The catalog identifier for the program management account.
1737
+ # @return [String]
1738
+ #
1739
+ # @!attribute [rw] identifier
1740
+ # The unique identifier of the program management account to update.
1741
+ # @return [String]
1742
+ #
1743
+ # @!attribute [rw] revision
1744
+ # The current revision number of the program management account.
1745
+ # @return [String]
1746
+ #
1747
+ # @!attribute [rw] display_name
1748
+ # The new display name for the program management account.
1749
+ # @return [String]
1750
+ #
1751
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/UpdateProgramManagementAccountRequest AWS API Documentation
1752
+ #
1753
+ class UpdateProgramManagementAccountRequest < Struct.new(
1754
+ :catalog,
1755
+ :identifier,
1756
+ :revision,
1757
+ :display_name)
1758
+ SENSITIVE = []
1759
+ include Aws::Structure
1760
+ end
1761
+
1762
+ # @!attribute [rw] program_management_account_detail
1763
+ # Details of the updated program management account.
1764
+ # @return [Types::UpdateProgramManagementAccountDetail]
1765
+ #
1766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/UpdateProgramManagementAccountResponse AWS API Documentation
1767
+ #
1768
+ class UpdateProgramManagementAccountResponse < Struct.new(
1769
+ :program_management_account_detail)
1770
+ SENSITIVE = []
1771
+ include Aws::Structure
1772
+ end
1773
+
1774
+ # Contains details about an updated relationship.
1775
+ #
1776
+ # @!attribute [rw] arn
1777
+ # The Amazon Resource Name (ARN) of the updated relationship.
1778
+ # @return [String]
1779
+ #
1780
+ # @!attribute [rw] id
1781
+ # The unique identifier of the updated relationship.
1782
+ # @return [String]
1783
+ #
1784
+ # @!attribute [rw] revision
1785
+ # The new revision number of the relationship.
1786
+ # @return [String]
1787
+ #
1788
+ # @!attribute [rw] display_name
1789
+ # The updated display name of the relationship.
1790
+ # @return [String]
1791
+ #
1792
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/UpdateRelationshipDetail AWS API Documentation
1793
+ #
1794
+ class UpdateRelationshipDetail < Struct.new(
1795
+ :arn,
1796
+ :id,
1797
+ :revision,
1798
+ :display_name)
1799
+ SENSITIVE = []
1800
+ include Aws::Structure
1801
+ end
1802
+
1803
+ # @!attribute [rw] catalog
1804
+ # The catalog identifier for the relationship.
1805
+ # @return [String]
1806
+ #
1807
+ # @!attribute [rw] identifier
1808
+ # The unique identifier of the relationship to update.
1809
+ # @return [String]
1810
+ #
1811
+ # @!attribute [rw] program_management_account_identifier
1812
+ # The identifier of the program management account associated with the
1813
+ # relationship.
1814
+ # @return [String]
1815
+ #
1816
+ # @!attribute [rw] revision
1817
+ # The current revision number of the relationship.
1818
+ # @return [String]
1819
+ #
1820
+ # @!attribute [rw] display_name
1821
+ # The new display name for the relationship.
1822
+ # @return [String]
1823
+ #
1824
+ # @!attribute [rw] requested_support_plan
1825
+ # The updated support plan for the relationship.
1826
+ # @return [Types::SupportPlan]
1827
+ #
1828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/UpdateRelationshipRequest AWS API Documentation
1829
+ #
1830
+ class UpdateRelationshipRequest < Struct.new(
1831
+ :catalog,
1832
+ :identifier,
1833
+ :program_management_account_identifier,
1834
+ :revision,
1835
+ :display_name,
1836
+ :requested_support_plan)
1837
+ SENSITIVE = []
1838
+ include Aws::Structure
1839
+ end
1840
+
1841
+ # @!attribute [rw] relationship_detail
1842
+ # Details of the updated relationship.
1843
+ # @return [Types::UpdateRelationshipDetail]
1844
+ #
1845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/UpdateRelationshipResponse AWS API Documentation
1846
+ #
1847
+ class UpdateRelationshipResponse < Struct.new(
1848
+ :relationship_detail)
1849
+ SENSITIVE = []
1850
+ include Aws::Structure
1851
+ end
1852
+
1853
+ # The request failed validation due to invalid input parameters.
1854
+ #
1855
+ # @!attribute [rw] message
1856
+ # A message describing the validation error.
1857
+ # @return [String]
1858
+ #
1859
+ # @!attribute [rw] reason
1860
+ # The reason for the validation failure.
1861
+ # @return [String]
1862
+ #
1863
+ # @!attribute [rw] field_list
1864
+ # A list of fields that failed validation.
1865
+ # @return [Array<Types::ValidationExceptionField>]
1866
+ #
1867
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ValidationException AWS API Documentation
1868
+ #
1869
+ class ValidationException < Struct.new(
1870
+ :message,
1871
+ :reason,
1872
+ :field_list)
1873
+ SENSITIVE = []
1874
+ include Aws::Structure
1875
+ end
1876
+
1877
+ # Information about a field that failed validation.
1878
+ #
1879
+ # @!attribute [rw] name
1880
+ # The name of the field that failed validation.
1881
+ # @return [String]
1882
+ #
1883
+ # @!attribute [rw] code
1884
+ # The validation error code for the field.
1885
+ # @return [String]
1886
+ #
1887
+ # @!attribute [rw] message
1888
+ # A descriptive message about the validation error.
1889
+ # @return [String]
1890
+ #
1891
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ValidationExceptionField AWS API Documentation
1892
+ #
1893
+ class ValidationExceptionField < Struct.new(
1894
+ :name,
1895
+ :code,
1896
+ :message)
1897
+ SENSITIVE = []
1898
+ include Aws::Structure
1899
+ end
1900
+
1901
+ end
1902
+ end
1903
+