@aws-sdk/client-cleanrooms 3.879.0 → 3.881.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.
- package/README.md +24 -0
- package/dist-cjs/index.js +221 -15
- package/dist-es/CleanRooms.js +6 -0
- package/dist-es/commands/CreateCollaborationChangeRequestCommand.js +22 -0
- package/dist-es/commands/GetCollaborationChangeRequestCommand.js +22 -0
- package/dist-es/commands/ListCollaborationChangeRequestsCommand.js +22 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +24 -15
- package/dist-es/models/models_1.js +15 -0
- package/dist-es/pagination/ListCollaborationChangeRequestsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +113 -0
- package/dist-types/CleanRooms.d.ts +21 -0
- package/dist-types/CleanRoomsClient.d.ts +5 -2
- package/dist-types/commands/CreateCollaborationChangeRequestCommand.d.ts +131 -0
- package/dist-types/commands/CreateCollaborationCommand.d.ts +6 -0
- package/dist-types/commands/CreateMembershipCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMembershipCommand.d.ts +1 -1
- package/dist-types/commands/GetCollaborationChangeRequestCommand.d.ts +112 -0
- package/dist-types/commands/GetCollaborationCommand.d.ts +3 -0
- package/dist-types/commands/GetMembershipCommand.d.ts +1 -1
- package/dist-types/commands/GetProtectedJobCommand.d.ts +1 -2
- package/dist-types/commands/ListCollaborationChangeRequestsCommand.d.ts +117 -0
- package/dist-types/commands/UpdateCollaborationCommand.d.ts +3 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +318 -317
- package/dist-types/models/models_1.d.ts +318 -1
- package/dist-types/pagination/ListCollaborationChangeRequestsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/CleanRooms.d.ts +51 -0
- package/dist-types/ts3.4/CleanRoomsClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/CreateCollaborationChangeRequestCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateMembershipCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteMembershipCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetCollaborationChangeRequestCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetMembershipCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetProtectedJobCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListCollaborationChangeRequestsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +101 -106
- package/dist-types/ts3.4/models/models_1.d.ts +106 -6
- package/dist-types/ts3.4/pagination/ListCollaborationChangeRequestsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +1 -1
|
@@ -1725,6 +1725,17 @@ export interface AthenaTableReference {
|
|
|
1725
1725
|
*/
|
|
1726
1726
|
tableName: string | undefined;
|
|
1727
1727
|
}
|
|
1728
|
+
/**
|
|
1729
|
+
* @public
|
|
1730
|
+
* @enum
|
|
1731
|
+
*/
|
|
1732
|
+
export declare const AutoApprovedChangeType: {
|
|
1733
|
+
readonly ADD_MEMBER: "ADD_MEMBER";
|
|
1734
|
+
};
|
|
1735
|
+
/**
|
|
1736
|
+
* @public
|
|
1737
|
+
*/
|
|
1738
|
+
export type AutoApprovedChangeType = (typeof AutoApprovedChangeType)[keyof typeof AutoApprovedChangeType];
|
|
1728
1739
|
/**
|
|
1729
1740
|
* @public
|
|
1730
1741
|
*/
|
|
@@ -2528,6 +2539,11 @@ export interface CreateCollaborationInput {
|
|
|
2528
2539
|
* @public
|
|
2529
2540
|
*/
|
|
2530
2541
|
analyticsEngine?: AnalyticsEngine | undefined;
|
|
2542
|
+
/**
|
|
2543
|
+
* <p>The types of change requests that are automatically approved for this collaboration.</p>
|
|
2544
|
+
* @public
|
|
2545
|
+
*/
|
|
2546
|
+
autoApprovedChangeRequestTypes?: AutoApprovedChangeType[] | undefined;
|
|
2531
2547
|
}
|
|
2532
2548
|
/**
|
|
2533
2549
|
* @public
|
|
@@ -2623,6 +2639,11 @@ export interface Collaboration {
|
|
|
2623
2639
|
* @public
|
|
2624
2640
|
*/
|
|
2625
2641
|
analyticsEngine?: AnalyticsEngine | undefined;
|
|
2642
|
+
/**
|
|
2643
|
+
* <p>The types of change requests that are automatically approved for this collaboration.</p>
|
|
2644
|
+
* @public
|
|
2645
|
+
*/
|
|
2646
|
+
autoApprovedChangeTypes?: AutoApprovedChangeType[] | undefined;
|
|
2626
2647
|
}
|
|
2627
2648
|
/**
|
|
2628
2649
|
* @public
|
|
@@ -2634,6 +2655,197 @@ export interface CreateCollaborationOutput {
|
|
|
2634
2655
|
*/
|
|
2635
2656
|
collaboration: Collaboration | undefined;
|
|
2636
2657
|
}
|
|
2658
|
+
/**
|
|
2659
|
+
* <p>Specifies changes to collaboration membership, including adding new members with their abilities and display names.</p>
|
|
2660
|
+
* @public
|
|
2661
|
+
*/
|
|
2662
|
+
export interface MemberChangeSpecification {
|
|
2663
|
+
/**
|
|
2664
|
+
* <p>The Amazon Web Services account ID of the member to add to the collaboration.</p>
|
|
2665
|
+
* @public
|
|
2666
|
+
*/
|
|
2667
|
+
accountId: string | undefined;
|
|
2668
|
+
/**
|
|
2669
|
+
* <p>The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.</p> <note> <p>The following values are currently not supported: <code>CAN_QUERY</code>, <code>CAN_RECEIVE_RESULTS,</code> and <code>CAN_RUN_JOB</code>. </p> <p>Set the value of <code>memberAbilities</code> to <code>[]</code> to allow a member to contribute data.</p> </note>
|
|
2670
|
+
* @public
|
|
2671
|
+
*/
|
|
2672
|
+
memberAbilities: MemberAbility[] | undefined;
|
|
2673
|
+
/**
|
|
2674
|
+
* <p>Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members. </p>
|
|
2675
|
+
* @public
|
|
2676
|
+
*/
|
|
2677
|
+
displayName?: string | undefined;
|
|
2678
|
+
}
|
|
2679
|
+
/**
|
|
2680
|
+
* <p>A union that contains the specification details for different types of changes.</p>
|
|
2681
|
+
* @public
|
|
2682
|
+
*/
|
|
2683
|
+
export type ChangeSpecification = ChangeSpecification.MemberMember | ChangeSpecification.$UnknownMember;
|
|
2684
|
+
/**
|
|
2685
|
+
* @public
|
|
2686
|
+
*/
|
|
2687
|
+
export declare namespace ChangeSpecification {
|
|
2688
|
+
/**
|
|
2689
|
+
* <p>The member change specification when the change type is <code>MEMBER</code>.</p>
|
|
2690
|
+
* @public
|
|
2691
|
+
*/
|
|
2692
|
+
interface MemberMember {
|
|
2693
|
+
member: MemberChangeSpecification;
|
|
2694
|
+
$unknown?: never;
|
|
2695
|
+
}
|
|
2696
|
+
/**
|
|
2697
|
+
* @public
|
|
2698
|
+
*/
|
|
2699
|
+
interface $UnknownMember {
|
|
2700
|
+
member?: never;
|
|
2701
|
+
$unknown: [string, any];
|
|
2702
|
+
}
|
|
2703
|
+
interface Visitor<T> {
|
|
2704
|
+
member: (value: MemberChangeSpecification) => T;
|
|
2705
|
+
_: (name: string, value: any) => T;
|
|
2706
|
+
}
|
|
2707
|
+
const visit: <T>(value: ChangeSpecification, visitor: Visitor<T>) => T;
|
|
2708
|
+
}
|
|
2709
|
+
/**
|
|
2710
|
+
* @public
|
|
2711
|
+
* @enum
|
|
2712
|
+
*/
|
|
2713
|
+
export declare const ChangeSpecificationType: {
|
|
2714
|
+
readonly MEMBER: "MEMBER";
|
|
2715
|
+
};
|
|
2716
|
+
/**
|
|
2717
|
+
* @public
|
|
2718
|
+
*/
|
|
2719
|
+
export type ChangeSpecificationType = (typeof ChangeSpecificationType)[keyof typeof ChangeSpecificationType];
|
|
2720
|
+
/**
|
|
2721
|
+
* <p>Specifies a change to apply to a collaboration.</p>
|
|
2722
|
+
* @public
|
|
2723
|
+
*/
|
|
2724
|
+
export interface ChangeInput {
|
|
2725
|
+
/**
|
|
2726
|
+
* <p>The type of specification for the change. Currently supports <code>MEMBER</code> for member-related changes.</p>
|
|
2727
|
+
* @public
|
|
2728
|
+
*/
|
|
2729
|
+
specificationType: ChangeSpecificationType | undefined;
|
|
2730
|
+
/**
|
|
2731
|
+
* <p>The specification details for the change. The structure depends on the specification type.</p>
|
|
2732
|
+
* @public
|
|
2733
|
+
*/
|
|
2734
|
+
specification: ChangeSpecification | undefined;
|
|
2735
|
+
}
|
|
2736
|
+
/**
|
|
2737
|
+
* @public
|
|
2738
|
+
*/
|
|
2739
|
+
export interface CreateCollaborationChangeRequestInput {
|
|
2740
|
+
/**
|
|
2741
|
+
* <p>The identifier of the collaboration that the change request is made against.</p>
|
|
2742
|
+
* @public
|
|
2743
|
+
*/
|
|
2744
|
+
collaborationIdentifier: string | undefined;
|
|
2745
|
+
/**
|
|
2746
|
+
* <p>The list of changes to apply to the collaboration. Each change specifies the type of modification and the details of what should be changed.</p>
|
|
2747
|
+
* @public
|
|
2748
|
+
*/
|
|
2749
|
+
changes: ChangeInput[] | undefined;
|
|
2750
|
+
}
|
|
2751
|
+
/**
|
|
2752
|
+
* @public
|
|
2753
|
+
* @enum
|
|
2754
|
+
*/
|
|
2755
|
+
export declare const ChangeType: {
|
|
2756
|
+
readonly ADD_MEMBER: "ADD_MEMBER";
|
|
2757
|
+
};
|
|
2758
|
+
/**
|
|
2759
|
+
* @public
|
|
2760
|
+
*/
|
|
2761
|
+
export type ChangeType = (typeof ChangeType)[keyof typeof ChangeType];
|
|
2762
|
+
/**
|
|
2763
|
+
* <p>Represents a single change within a collaboration change request, containing the change identifier and specification.</p>
|
|
2764
|
+
* @public
|
|
2765
|
+
*/
|
|
2766
|
+
export interface Change {
|
|
2767
|
+
/**
|
|
2768
|
+
* <p>The type of specification for this change.</p>
|
|
2769
|
+
* @public
|
|
2770
|
+
*/
|
|
2771
|
+
specificationType: ChangeSpecificationType | undefined;
|
|
2772
|
+
/**
|
|
2773
|
+
* <p>The specification details for this change.</p>
|
|
2774
|
+
* @public
|
|
2775
|
+
*/
|
|
2776
|
+
specification: ChangeSpecification | undefined;
|
|
2777
|
+
/**
|
|
2778
|
+
* <p>The list of change types that were applied.</p>
|
|
2779
|
+
* @public
|
|
2780
|
+
*/
|
|
2781
|
+
types: ChangeType[] | undefined;
|
|
2782
|
+
}
|
|
2783
|
+
/**
|
|
2784
|
+
* @public
|
|
2785
|
+
* @enum
|
|
2786
|
+
*/
|
|
2787
|
+
export declare const ChangeRequestStatus: {
|
|
2788
|
+
readonly APPROVED: "APPROVED";
|
|
2789
|
+
readonly CANCELLED: "CANCELLED";
|
|
2790
|
+
readonly COMMITTED: "COMMITTED";
|
|
2791
|
+
readonly DENIED: "DENIED";
|
|
2792
|
+
readonly PENDING: "PENDING";
|
|
2793
|
+
};
|
|
2794
|
+
/**
|
|
2795
|
+
* @public
|
|
2796
|
+
*/
|
|
2797
|
+
export type ChangeRequestStatus = (typeof ChangeRequestStatus)[keyof typeof ChangeRequestStatus];
|
|
2798
|
+
/**
|
|
2799
|
+
* <p>Represents a request to modify a collaboration. Change requests enable structured modifications to collaborations after they have been created.</p>
|
|
2800
|
+
* @public
|
|
2801
|
+
*/
|
|
2802
|
+
export interface CollaborationChangeRequest {
|
|
2803
|
+
/**
|
|
2804
|
+
* <p>The unique identifier for the change request.</p>
|
|
2805
|
+
* @public
|
|
2806
|
+
*/
|
|
2807
|
+
id: string | undefined;
|
|
2808
|
+
/**
|
|
2809
|
+
* <p>The unique identifier for the collaboration being modified.</p>
|
|
2810
|
+
* @public
|
|
2811
|
+
*/
|
|
2812
|
+
collaborationId: string | undefined;
|
|
2813
|
+
/**
|
|
2814
|
+
* <p>The time when the change request was created.</p>
|
|
2815
|
+
* @public
|
|
2816
|
+
*/
|
|
2817
|
+
createTime: Date | undefined;
|
|
2818
|
+
/**
|
|
2819
|
+
* <p>The time when the change request was last updated.</p>
|
|
2820
|
+
* @public
|
|
2821
|
+
*/
|
|
2822
|
+
updateTime: Date | undefined;
|
|
2823
|
+
/**
|
|
2824
|
+
* <p>The current status of the change request. Valid values are <code>PENDING</code>, <code>APPROVED</code>, <code>DENIED</code>, <code>COMMITTED</code>, and <code>CANCELLED</code>.</p>
|
|
2825
|
+
* @public
|
|
2826
|
+
*/
|
|
2827
|
+
status: ChangeRequestStatus | undefined;
|
|
2828
|
+
/**
|
|
2829
|
+
* <p>Whether the change request was automatically approved based on the collaboration's auto-approval settings.</p>
|
|
2830
|
+
* @public
|
|
2831
|
+
*/
|
|
2832
|
+
isAutoApproved: boolean | undefined;
|
|
2833
|
+
/**
|
|
2834
|
+
* <p>The list of changes specified in this change request.</p>
|
|
2835
|
+
* @public
|
|
2836
|
+
*/
|
|
2837
|
+
changes: Change[] | undefined;
|
|
2838
|
+
}
|
|
2839
|
+
/**
|
|
2840
|
+
* @public
|
|
2841
|
+
*/
|
|
2842
|
+
export interface CreateCollaborationChangeRequestOutput {
|
|
2843
|
+
/**
|
|
2844
|
+
* <p>Represents a request to modify a collaboration. Change requests enable structured modifications to collaborations after they have been created.</p>
|
|
2845
|
+
* @public
|
|
2846
|
+
*/
|
|
2847
|
+
collaborationChangeRequest: CollaborationChangeRequest | undefined;
|
|
2848
|
+
}
|
|
2637
2849
|
/**
|
|
2638
2850
|
* @public
|
|
2639
2851
|
*/
|
|
@@ -2714,6 +2926,31 @@ export interface GetCollaborationAnalysisTemplateOutput {
|
|
|
2714
2926
|
*/
|
|
2715
2927
|
collaborationAnalysisTemplate: CollaborationAnalysisTemplate | undefined;
|
|
2716
2928
|
}
|
|
2929
|
+
/**
|
|
2930
|
+
* @public
|
|
2931
|
+
*/
|
|
2932
|
+
export interface GetCollaborationChangeRequestInput {
|
|
2933
|
+
/**
|
|
2934
|
+
* <p>The identifier of the collaboration that the change request is made against.</p>
|
|
2935
|
+
* @public
|
|
2936
|
+
*/
|
|
2937
|
+
collaborationIdentifier: string | undefined;
|
|
2938
|
+
/**
|
|
2939
|
+
* <p>A unique identifier for the change request to retrieve.</p>
|
|
2940
|
+
* @public
|
|
2941
|
+
*/
|
|
2942
|
+
changeRequestIdentifier: string | undefined;
|
|
2943
|
+
}
|
|
2944
|
+
/**
|
|
2945
|
+
* @public
|
|
2946
|
+
*/
|
|
2947
|
+
export interface GetCollaborationChangeRequestOutput {
|
|
2948
|
+
/**
|
|
2949
|
+
* <p>The collaboration change request that was requested.</p>
|
|
2950
|
+
* @public
|
|
2951
|
+
*/
|
|
2952
|
+
collaborationChangeRequest: CollaborationChangeRequest | undefined;
|
|
2953
|
+
}
|
|
2717
2954
|
/**
|
|
2718
2955
|
* @public
|
|
2719
2956
|
*/
|
|
@@ -3220,6 +3457,87 @@ export interface ListCollaborationAnalysisTemplatesOutput {
|
|
|
3220
3457
|
*/
|
|
3221
3458
|
collaborationAnalysisTemplateSummaries: CollaborationAnalysisTemplateSummary[] | undefined;
|
|
3222
3459
|
}
|
|
3460
|
+
/**
|
|
3461
|
+
* @public
|
|
3462
|
+
*/
|
|
3463
|
+
export interface ListCollaborationChangeRequestsInput {
|
|
3464
|
+
/**
|
|
3465
|
+
* <p>The identifier of the collaboration that the change request is made against.</p>
|
|
3466
|
+
* @public
|
|
3467
|
+
*/
|
|
3468
|
+
collaborationIdentifier: string | undefined;
|
|
3469
|
+
/**
|
|
3470
|
+
* <p>A filter to only return change requests with the specified status.</p>
|
|
3471
|
+
* @public
|
|
3472
|
+
*/
|
|
3473
|
+
status?: ChangeRequestStatus | undefined;
|
|
3474
|
+
/**
|
|
3475
|
+
* <p>The pagination token that's used to fetch the next set of results.</p>
|
|
3476
|
+
* @public
|
|
3477
|
+
*/
|
|
3478
|
+
nextToken?: string | undefined;
|
|
3479
|
+
/**
|
|
3480
|
+
* <p>The maximum number of results that are returned for an API request call.</p>
|
|
3481
|
+
* @public
|
|
3482
|
+
*/
|
|
3483
|
+
maxResults?: number | undefined;
|
|
3484
|
+
}
|
|
3485
|
+
/**
|
|
3486
|
+
* <p>Summary information about a collaboration change request.</p>
|
|
3487
|
+
* @public
|
|
3488
|
+
*/
|
|
3489
|
+
export interface CollaborationChangeRequestSummary {
|
|
3490
|
+
/**
|
|
3491
|
+
* <p>The unique identifier for the change request.</p>
|
|
3492
|
+
* @public
|
|
3493
|
+
*/
|
|
3494
|
+
id: string | undefined;
|
|
3495
|
+
/**
|
|
3496
|
+
* <p>The unique identifier for the collaboration.</p>
|
|
3497
|
+
* @public
|
|
3498
|
+
*/
|
|
3499
|
+
collaborationId: string | undefined;
|
|
3500
|
+
/**
|
|
3501
|
+
* <p>The time when the change request was created.</p>
|
|
3502
|
+
* @public
|
|
3503
|
+
*/
|
|
3504
|
+
createTime: Date | undefined;
|
|
3505
|
+
/**
|
|
3506
|
+
* <p>The time when the change request was last updated.</p>
|
|
3507
|
+
* @public
|
|
3508
|
+
*/
|
|
3509
|
+
updateTime: Date | undefined;
|
|
3510
|
+
/**
|
|
3511
|
+
* <p>The current status of the change request.</p>
|
|
3512
|
+
* @public
|
|
3513
|
+
*/
|
|
3514
|
+
status: ChangeRequestStatus | undefined;
|
|
3515
|
+
/**
|
|
3516
|
+
* <p>Whether the change request was automatically approved.</p>
|
|
3517
|
+
* @public
|
|
3518
|
+
*/
|
|
3519
|
+
isAutoApproved: boolean | undefined;
|
|
3520
|
+
/**
|
|
3521
|
+
* <p>Summary of the changes in this change request.</p>
|
|
3522
|
+
* @public
|
|
3523
|
+
*/
|
|
3524
|
+
changes: Change[] | undefined;
|
|
3525
|
+
}
|
|
3526
|
+
/**
|
|
3527
|
+
* @public
|
|
3528
|
+
*/
|
|
3529
|
+
export interface ListCollaborationChangeRequestsOutput {
|
|
3530
|
+
/**
|
|
3531
|
+
* <p>The list of collaboration change request summaries.</p>
|
|
3532
|
+
* @public
|
|
3533
|
+
*/
|
|
3534
|
+
collaborationChangeRequestSummaries: CollaborationChangeRequestSummary[] | undefined;
|
|
3535
|
+
/**
|
|
3536
|
+
* <p>The pagination token that's used to fetch the next set of results.</p>
|
|
3537
|
+
* @public
|
|
3538
|
+
*/
|
|
3539
|
+
nextToken?: string | undefined;
|
|
3540
|
+
}
|
|
3223
3541
|
/**
|
|
3224
3542
|
* @public
|
|
3225
3543
|
*/
|
|
@@ -6330,323 +6648,6 @@ export declare const MembershipQueryLogStatus: {
|
|
|
6330
6648
|
* @public
|
|
6331
6649
|
*/
|
|
6332
6650
|
export type MembershipQueryLogStatus = (typeof MembershipQueryLogStatus)[keyof typeof MembershipQueryLogStatus];
|
|
6333
|
-
/**
|
|
6334
|
-
* @public
|
|
6335
|
-
*/
|
|
6336
|
-
export interface CreateMembershipInput {
|
|
6337
|
-
/**
|
|
6338
|
-
* <p>The unique ID for the associated collaboration.</p>
|
|
6339
|
-
* @public
|
|
6340
|
-
*/
|
|
6341
|
-
collaborationIdentifier: string | undefined;
|
|
6342
|
-
/**
|
|
6343
|
-
* <p>An indicator as to whether query logging has been enabled or disabled for the membership.</p> <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
|
|
6344
|
-
* @public
|
|
6345
|
-
*/
|
|
6346
|
-
queryLogStatus: MembershipQueryLogStatus | undefined;
|
|
6347
|
-
/**
|
|
6348
|
-
* <p>An indicator as to whether job logging has been enabled or disabled for the collaboration. </p> <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
|
|
6349
|
-
* @public
|
|
6350
|
-
*/
|
|
6351
|
-
jobLogStatus?: MembershipJobLogStatus | undefined;
|
|
6352
|
-
/**
|
|
6353
|
-
* <p>An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.</p>
|
|
6354
|
-
* @public
|
|
6355
|
-
*/
|
|
6356
|
-
tags?: Record<string, string> | undefined;
|
|
6357
|
-
/**
|
|
6358
|
-
* <p>The default protected query result configuration as specified by the member who can receive results.</p>
|
|
6359
|
-
* @public
|
|
6360
|
-
*/
|
|
6361
|
-
defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration | undefined;
|
|
6362
|
-
/**
|
|
6363
|
-
* <p>The default job result configuration that determines how job results are protected and managed within this membership. This configuration applies to all jobs.</p>
|
|
6364
|
-
* @public
|
|
6365
|
-
*/
|
|
6366
|
-
defaultJobResultConfiguration?: MembershipProtectedJobResultConfiguration | undefined;
|
|
6367
|
-
/**
|
|
6368
|
-
* <p>The payment responsibilities accepted by the collaboration member.</p> <p>Not required if the collaboration member has the member ability to run queries. </p> <p>Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator. </p>
|
|
6369
|
-
* @public
|
|
6370
|
-
*/
|
|
6371
|
-
paymentConfiguration?: MembershipPaymentConfiguration | undefined;
|
|
6372
|
-
}
|
|
6373
|
-
/**
|
|
6374
|
-
* @public
|
|
6375
|
-
* @enum
|
|
6376
|
-
*/
|
|
6377
|
-
export declare const MembershipStatus: {
|
|
6378
|
-
readonly ACTIVE: "ACTIVE";
|
|
6379
|
-
readonly COLLABORATION_DELETED: "COLLABORATION_DELETED";
|
|
6380
|
-
readonly REMOVED: "REMOVED";
|
|
6381
|
-
};
|
|
6382
|
-
/**
|
|
6383
|
-
* @public
|
|
6384
|
-
*/
|
|
6385
|
-
export type MembershipStatus = (typeof MembershipStatus)[keyof typeof MembershipStatus];
|
|
6386
|
-
/**
|
|
6387
|
-
* <p>The membership object.</p>
|
|
6388
|
-
* @public
|
|
6389
|
-
*/
|
|
6390
|
-
export interface Membership {
|
|
6391
|
-
/**
|
|
6392
|
-
* <p>The unique ID of the membership.</p>
|
|
6393
|
-
* @public
|
|
6394
|
-
*/
|
|
6395
|
-
id: string | undefined;
|
|
6396
|
-
/**
|
|
6397
|
-
* <p>The unique ARN for the membership.</p>
|
|
6398
|
-
* @public
|
|
6399
|
-
*/
|
|
6400
|
-
arn: string | undefined;
|
|
6401
|
-
/**
|
|
6402
|
-
* <p>The unique ARN for the membership's associated collaboration.</p>
|
|
6403
|
-
* @public
|
|
6404
|
-
*/
|
|
6405
|
-
collaborationArn: string | undefined;
|
|
6406
|
-
/**
|
|
6407
|
-
* <p>The unique ID for the membership's collaboration.</p>
|
|
6408
|
-
* @public
|
|
6409
|
-
*/
|
|
6410
|
-
collaborationId: string | undefined;
|
|
6411
|
-
/**
|
|
6412
|
-
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
6413
|
-
* @public
|
|
6414
|
-
*/
|
|
6415
|
-
collaborationCreatorAccountId: string | undefined;
|
|
6416
|
-
/**
|
|
6417
|
-
* <p>The display name of the collaboration creator.</p>
|
|
6418
|
-
* @public
|
|
6419
|
-
*/
|
|
6420
|
-
collaborationCreatorDisplayName: string | undefined;
|
|
6421
|
-
/**
|
|
6422
|
-
* <p>The name of the membership's collaboration.</p>
|
|
6423
|
-
* @public
|
|
6424
|
-
*/
|
|
6425
|
-
collaborationName: string | undefined;
|
|
6426
|
-
/**
|
|
6427
|
-
* <p>The time when the membership was created.</p>
|
|
6428
|
-
* @public
|
|
6429
|
-
*/
|
|
6430
|
-
createTime: Date | undefined;
|
|
6431
|
-
/**
|
|
6432
|
-
* <p>The time the membership metadata was last updated.</p>
|
|
6433
|
-
* @public
|
|
6434
|
-
*/
|
|
6435
|
-
updateTime: Date | undefined;
|
|
6436
|
-
/**
|
|
6437
|
-
* <p>The status of the membership.</p>
|
|
6438
|
-
* @public
|
|
6439
|
-
*/
|
|
6440
|
-
status: MembershipStatus | undefined;
|
|
6441
|
-
/**
|
|
6442
|
-
* <p>The abilities granted to the collaboration member.</p>
|
|
6443
|
-
* @public
|
|
6444
|
-
*/
|
|
6445
|
-
memberAbilities: MemberAbility[] | undefined;
|
|
6446
|
-
/**
|
|
6447
|
-
* <p>Specifies the ML member abilities that are granted to a collaboration member.</p>
|
|
6448
|
-
* @public
|
|
6449
|
-
*/
|
|
6450
|
-
mlMemberAbilities?: MLMemberAbilities | undefined;
|
|
6451
|
-
/**
|
|
6452
|
-
* <p>An indicator as to whether query logging has been enabled or disabled for the membership.</p> <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
|
|
6453
|
-
* @public
|
|
6454
|
-
*/
|
|
6455
|
-
queryLogStatus: MembershipQueryLogStatus | undefined;
|
|
6456
|
-
/**
|
|
6457
|
-
* <p>An indicator as to whether job logging has been enabled or disabled for the collaboration. </p> <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
|
|
6458
|
-
* @public
|
|
6459
|
-
*/
|
|
6460
|
-
jobLogStatus?: MembershipJobLogStatus | undefined;
|
|
6461
|
-
/**
|
|
6462
|
-
* <p>The default protected query result configuration as specified by the member who can receive results.</p>
|
|
6463
|
-
* @public
|
|
6464
|
-
*/
|
|
6465
|
-
defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration | undefined;
|
|
6466
|
-
/**
|
|
6467
|
-
* <p> The default job result configuration for the membership.</p>
|
|
6468
|
-
* @public
|
|
6469
|
-
*/
|
|
6470
|
-
defaultJobResultConfiguration?: MembershipProtectedJobResultConfiguration | undefined;
|
|
6471
|
-
/**
|
|
6472
|
-
* <p>The payment responsibilities accepted by the collaboration member.</p>
|
|
6473
|
-
* @public
|
|
6474
|
-
*/
|
|
6475
|
-
paymentConfiguration: MembershipPaymentConfiguration | undefined;
|
|
6476
|
-
}
|
|
6477
|
-
/**
|
|
6478
|
-
* @public
|
|
6479
|
-
*/
|
|
6480
|
-
export interface CreateMembershipOutput {
|
|
6481
|
-
/**
|
|
6482
|
-
* <p>The membership that was created.</p>
|
|
6483
|
-
* @public
|
|
6484
|
-
*/
|
|
6485
|
-
membership: Membership | undefined;
|
|
6486
|
-
}
|
|
6487
|
-
/**
|
|
6488
|
-
* @public
|
|
6489
|
-
*/
|
|
6490
|
-
export interface DeleteMembershipInput {
|
|
6491
|
-
/**
|
|
6492
|
-
* <p>The identifier for a membership resource.</p>
|
|
6493
|
-
* @public
|
|
6494
|
-
*/
|
|
6495
|
-
membershipIdentifier: string | undefined;
|
|
6496
|
-
}
|
|
6497
|
-
/**
|
|
6498
|
-
* @public
|
|
6499
|
-
*/
|
|
6500
|
-
export interface DeleteMembershipOutput {
|
|
6501
|
-
}
|
|
6502
|
-
/**
|
|
6503
|
-
* @public
|
|
6504
|
-
*/
|
|
6505
|
-
export interface GetMembershipInput {
|
|
6506
|
-
/**
|
|
6507
|
-
* <p>The identifier for a membership resource.</p>
|
|
6508
|
-
* @public
|
|
6509
|
-
*/
|
|
6510
|
-
membershipIdentifier: string | undefined;
|
|
6511
|
-
}
|
|
6512
|
-
/**
|
|
6513
|
-
* @public
|
|
6514
|
-
*/
|
|
6515
|
-
export interface GetMembershipOutput {
|
|
6516
|
-
/**
|
|
6517
|
-
* <p>The membership retrieved for the provided identifier.</p>
|
|
6518
|
-
* @public
|
|
6519
|
-
*/
|
|
6520
|
-
membership: Membership | undefined;
|
|
6521
|
-
}
|
|
6522
|
-
/**
|
|
6523
|
-
* @public
|
|
6524
|
-
*/
|
|
6525
|
-
export interface GetProtectedJobInput {
|
|
6526
|
-
/**
|
|
6527
|
-
* <p> The identifier for a membership in a protected job instance.</p>
|
|
6528
|
-
* @public
|
|
6529
|
-
*/
|
|
6530
|
-
membershipIdentifier: string | undefined;
|
|
6531
|
-
/**
|
|
6532
|
-
* <p> The identifier for the protected job instance.</p>
|
|
6533
|
-
* @public
|
|
6534
|
-
*/
|
|
6535
|
-
protectedJobIdentifier: string | undefined;
|
|
6536
|
-
}
|
|
6537
|
-
/**
|
|
6538
|
-
* <p>The protected job error.</p>
|
|
6539
|
-
* @public
|
|
6540
|
-
*/
|
|
6541
|
-
export interface ProtectedJobError {
|
|
6542
|
-
/**
|
|
6543
|
-
* <p> The message for the protected job error.</p>
|
|
6544
|
-
* @public
|
|
6545
|
-
*/
|
|
6546
|
-
message: string | undefined;
|
|
6547
|
-
/**
|
|
6548
|
-
* <p> The error code for the protected job.</p>
|
|
6549
|
-
* @public
|
|
6550
|
-
*/
|
|
6551
|
-
code: string | undefined;
|
|
6552
|
-
}
|
|
6553
|
-
/**
|
|
6554
|
-
* <p>The parameters for the protected job.</p>
|
|
6555
|
-
* @public
|
|
6556
|
-
*/
|
|
6557
|
-
export interface ProtectedJobParameters {
|
|
6558
|
-
/**
|
|
6559
|
-
* <p> The ARN of the analysis template.</p>
|
|
6560
|
-
* @public
|
|
6561
|
-
*/
|
|
6562
|
-
analysisTemplateArn?: string | undefined;
|
|
6563
|
-
}
|
|
6564
|
-
/**
|
|
6565
|
-
* <p>Details about the member who received the job result.</p>
|
|
6566
|
-
* @public
|
|
6567
|
-
*/
|
|
6568
|
-
export interface ProtectedJobSingleMemberOutput {
|
|
6569
|
-
/**
|
|
6570
|
-
* <p>The Amazon Web Services account ID of the member in the collaboration who can receive results from analyses.</p>
|
|
6571
|
-
* @public
|
|
6572
|
-
*/
|
|
6573
|
-
accountId: string | undefined;
|
|
6574
|
-
}
|
|
6575
|
-
/**
|
|
6576
|
-
* <p>Contains output information for protected jobs with an S3 output type.</p>
|
|
6577
|
-
* @public
|
|
6578
|
-
*/
|
|
6579
|
-
export interface ProtectedJobS3Output {
|
|
6580
|
-
/**
|
|
6581
|
-
* <p> The S3 location for the protected job output.</p>
|
|
6582
|
-
* @public
|
|
6583
|
-
*/
|
|
6584
|
-
location: string | undefined;
|
|
6585
|
-
}
|
|
6586
|
-
/**
|
|
6587
|
-
* <p>Contains details about the protected job output.</p>
|
|
6588
|
-
* @public
|
|
6589
|
-
*/
|
|
6590
|
-
export type ProtectedJobOutput = ProtectedJobOutput.MemberListMember | ProtectedJobOutput.S3Member | ProtectedJobOutput.$UnknownMember;
|
|
6591
|
-
/**
|
|
6592
|
-
* @public
|
|
6593
|
-
*/
|
|
6594
|
-
export declare namespace ProtectedJobOutput {
|
|
6595
|
-
/**
|
|
6596
|
-
* <p>If present, the output for a protected job with an `S3` output type.</p>
|
|
6597
|
-
* @public
|
|
6598
|
-
*/
|
|
6599
|
-
interface S3Member {
|
|
6600
|
-
s3: ProtectedJobS3Output;
|
|
6601
|
-
memberList?: never;
|
|
6602
|
-
$unknown?: never;
|
|
6603
|
-
}
|
|
6604
|
-
/**
|
|
6605
|
-
* <p>The list of member Amazon Web Services account(s) that received the results of the job. </p>
|
|
6606
|
-
* @public
|
|
6607
|
-
*/
|
|
6608
|
-
interface MemberListMember {
|
|
6609
|
-
s3?: never;
|
|
6610
|
-
memberList: ProtectedJobSingleMemberOutput[];
|
|
6611
|
-
$unknown?: never;
|
|
6612
|
-
}
|
|
6613
|
-
/**
|
|
6614
|
-
* @public
|
|
6615
|
-
*/
|
|
6616
|
-
interface $UnknownMember {
|
|
6617
|
-
s3?: never;
|
|
6618
|
-
memberList?: never;
|
|
6619
|
-
$unknown: [string, any];
|
|
6620
|
-
}
|
|
6621
|
-
interface Visitor<T> {
|
|
6622
|
-
s3: (value: ProtectedJobS3Output) => T;
|
|
6623
|
-
memberList: (value: ProtectedJobSingleMemberOutput[]) => T;
|
|
6624
|
-
_: (name: string, value: any) => T;
|
|
6625
|
-
}
|
|
6626
|
-
const visit: <T>(value: ProtectedJobOutput, visitor: Visitor<T>) => T;
|
|
6627
|
-
}
|
|
6628
|
-
/**
|
|
6629
|
-
* <p>Details about the job results.</p>
|
|
6630
|
-
* @public
|
|
6631
|
-
*/
|
|
6632
|
-
export interface ProtectedJobResult {
|
|
6633
|
-
/**
|
|
6634
|
-
* <p> The output of the protected job.</p>
|
|
6635
|
-
* @public
|
|
6636
|
-
*/
|
|
6637
|
-
output: ProtectedJobOutput | undefined;
|
|
6638
|
-
}
|
|
6639
|
-
/**
|
|
6640
|
-
* <p> The protected job member output configuration output.</p>
|
|
6641
|
-
* @public
|
|
6642
|
-
*/
|
|
6643
|
-
export interface ProtectedJobMemberOutputConfigurationOutput {
|
|
6644
|
-
/**
|
|
6645
|
-
* <p> The account ID.</p>
|
|
6646
|
-
* @public
|
|
6647
|
-
*/
|
|
6648
|
-
accountId: string | undefined;
|
|
6649
|
-
}
|
|
6650
6651
|
/**
|
|
6651
6652
|
* @internal
|
|
6652
6653
|
*/
|