cdk-comprehend-s3olap 2.0.150 → 2.0.152
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/.jsii +30 -4
- package/lib/cdk-comprehend-s3olap.js +2 -2
- package/lib/comprehend-lambdas.js +2 -2
- package/lib/iam-roles.js +4 -4
- package/node_modules/aws-sdk/CHANGELOG.md +17 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/elasticache-2015-02-02.min.json +147 -143
- package/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.min.json +85 -37
- package/node_modules/aws-sdk/apis/ivs-realtime-2020-07-14.min.json +223 -0
- package/node_modules/aws-sdk/apis/ivs-realtime-2020-07-14.paginators.json +15 -0
- package/node_modules/aws-sdk/apis/omics-2022-11-28.min.json +1393 -897
- package/node_modules/aws-sdk/apis/omics-2022-11-28.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/rds-2014-10-31.min.json +9 -3
- package/node_modules/aws-sdk/apis/support-2013-04-15.min.json +97 -14
- package/node_modules/aws-sdk/apis/swf-2012-01-25.min.json +3 -0
- package/node_modules/aws-sdk/clients/connect.d.ts +6 -6
- package/node_modules/aws-sdk/clients/elasticache.d.ts +25 -8
- package/node_modules/aws-sdk/clients/emr.d.ts +228 -136
- package/node_modules/aws-sdk/clients/es.d.ts +1 -1
- package/node_modules/aws-sdk/clients/health.d.ts +19 -19
- package/node_modules/aws-sdk/clients/ivsrealtime.d.ts +292 -8
- package/node_modules/aws-sdk/clients/omics.d.ts +1451 -965
- package/node_modules/aws-sdk/clients/rds.d.ts +26 -10
- package/node_modules/aws-sdk/clients/support.d.ts +134 -7
- package/node_modules/aws-sdk/clients/swf.d.ts +26 -21
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +1 -1
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +10 -10
- package/node_modules/aws-sdk/dist/aws-sdk.js +244 -186
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +58 -58
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/node_modules/aws-sdk/scripts/lib/ts-generator.js +1 -5
- package/package.json +7 -7
@@ -1151,7 +1151,7 @@ declare namespace ES {
|
|
1151
1151
|
*/
|
1152
1152
|
Name?: DescribePackagesFilterName;
|
1153
1153
|
/**
|
1154
|
-
* A list of values for the specified field.
|
1154
|
+
* A non-empty list of values for the specified field.
|
1155
1155
|
*/
|
1156
1156
|
Value?: DescribePackagesFilterValues;
|
1157
1157
|
}
|
@@ -20,19 +20,19 @@ declare class Health extends Service {
|
|
20
20
|
*/
|
21
21
|
describeAffectedAccountsForOrganization(callback?: (err: AWSError, data: Health.Types.DescribeAffectedAccountsForOrganizationResponse) => void): Request<Health.Types.DescribeAffectedAccountsForOrganizationResponse, AWSError>;
|
22
22
|
/**
|
23
|
-
* Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web
|
23
|
+
* Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this. At least one event ARN is required. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
|
24
24
|
*/
|
25
25
|
describeAffectedEntities(params: Health.Types.DescribeAffectedEntitiesRequest, callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesResponse) => void): Request<Health.Types.DescribeAffectedEntitiesResponse, AWSError>;
|
26
26
|
/**
|
27
|
-
* Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web
|
27
|
+
* Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this. At least one event ARN is required. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
|
28
28
|
*/
|
29
29
|
describeAffectedEntities(callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesResponse) => void): Request<Health.Types.DescribeAffectedEntitiesResponse, AWSError>;
|
30
30
|
/**
|
31
|
-
* Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web
|
31
|
+
* Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Service. At least one event Amazon Resource Name (ARN) and account ID are required. Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
|
32
32
|
*/
|
33
33
|
describeAffectedEntitiesForOrganization(params: Health.Types.DescribeAffectedEntitiesForOrganizationRequest, callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesForOrganizationResponse) => void): Request<Health.Types.DescribeAffectedEntitiesForOrganizationResponse, AWSError>;
|
34
34
|
/**
|
35
|
-
* Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web
|
35
|
+
* Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Service. At least one event Amazon Resource Name (ARN) and account ID are required. Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
|
36
36
|
*/
|
37
37
|
describeAffectedEntitiesForOrganization(callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesForOrganizationResponse) => void): Request<Health.Types.DescribeAffectedEntitiesForOrganizationResponse, AWSError>;
|
38
38
|
/**
|
@@ -68,11 +68,11 @@ declare class Health extends Service {
|
|
68
68
|
*/
|
69
69
|
describeEventDetailsForOrganization(callback?: (err: AWSError, data: Health.Types.DescribeEventDetailsForOrganizationResponse) => void): Request<Health.Types.DescribeEventDetailsForOrganizationResponse, AWSError>;
|
70
70
|
/**
|
71
|
-
* Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web
|
71
|
+
* Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Service, and event code. The metadata for each event appears in the EventType object. If you don't specify a filter criteria, the API operation returns all event types, in no particular order. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
|
72
72
|
*/
|
73
73
|
describeEventTypes(params: Health.Types.DescribeEventTypesRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventTypesResponse) => void): Request<Health.Types.DescribeEventTypesResponse, AWSError>;
|
74
74
|
/**
|
75
|
-
* Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web
|
75
|
+
* Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Service, and event code. The metadata for each event appears in the EventType object. If you don't specify a filter criteria, the API operation returns all event types, in no particular order. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
|
76
76
|
*/
|
77
77
|
describeEventTypes(callback?: (err: AWSError, data: Health.Types.DescribeEventTypesResponse) => void): Request<Health.Types.DescribeEventTypesResponse, AWSError>;
|
78
78
|
/**
|
@@ -92,11 +92,11 @@ declare class Health extends Service {
|
|
92
92
|
*/
|
93
93
|
describeEventsForOrganization(callback?: (err: AWSError, data: Health.Types.DescribeEventsForOrganizationResponse) => void): Request<Health.Types.DescribeEventsForOrganizationResponse, AWSError>;
|
94
94
|
/**
|
95
|
-
* This operation provides status information on enabling or disabling Health to work with your organization. To call this operation, you must
|
95
|
+
* This operation provides status information on enabling or disabling Health to work with your organization. To call this operation, you must use the organization's management account.
|
96
96
|
*/
|
97
97
|
describeHealthServiceStatusForOrganization(callback?: (err: AWSError, data: Health.Types.DescribeHealthServiceStatusForOrganizationResponse) => void): Request<Health.Types.DescribeHealthServiceStatusForOrganizationResponse, AWSError>;
|
98
98
|
/**
|
99
|
-
* Disables Health from working with Organizations. To call this operation, you must sign in
|
99
|
+
* Disables Health from working with Organizations. To call this operation, you must sign in to the organization's management account. For more information, see Aggregating Health events in the Health User Guide. This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or Command Line Interface (CLI) to remove the service-linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide. You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess API operation. After you call this operation, Health stops aggregating events for all other Amazon Web Services accounts in your organization. If you call the Health API operations for organizational view, Health returns an error. Health continues to aggregate health events for your Amazon Web Services account.
|
100
100
|
*/
|
101
101
|
disableHealthServiceAccessForOrganization(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
102
102
|
/**
|
@@ -169,7 +169,7 @@ declare namespace Health {
|
|
169
169
|
*/
|
170
170
|
affectedAccounts?: affectedAccountsList;
|
171
171
|
/**
|
172
|
-
* This parameter specifies if the Health event is a public Amazon Web
|
172
|
+
* This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event. If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty. If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response. If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.
|
173
173
|
*/
|
174
174
|
eventScopeCode?: eventScopeCode;
|
175
175
|
/**
|
@@ -336,7 +336,7 @@ declare namespace Health {
|
|
336
336
|
*/
|
337
337
|
nextToken?: nextToken;
|
338
338
|
/**
|
339
|
-
* The maximum number of items to return in one batch, between 10 and 100, inclusive.
|
339
|
+
* The maximum number of items to return in one batch, between 10 and 100, inclusive. If you don't specify the maxResults parameter, this operation returns a maximum of 30 items by default.
|
340
340
|
*/
|
341
341
|
maxResults?: maxResults;
|
342
342
|
}
|
@@ -456,7 +456,7 @@ declare namespace Health {
|
|
456
456
|
*/
|
457
457
|
arn?: eventArn;
|
458
458
|
/**
|
459
|
-
* The Amazon Web
|
459
|
+
* The Amazon Web Service that is affected by the event. For example, EC2, RDS.
|
460
460
|
*/
|
461
461
|
service?: service;
|
462
462
|
/**
|
@@ -492,7 +492,7 @@ declare namespace Health {
|
|
492
492
|
*/
|
493
493
|
statusCode?: eventStatusCode;
|
494
494
|
/**
|
495
|
-
* This parameter specifies if the Health event is a public Amazon Web
|
495
|
+
* This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event. If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty. If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response. If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.
|
496
496
|
*/
|
497
497
|
eventScopeCode?: eventScopeCode;
|
498
498
|
}
|
@@ -562,7 +562,7 @@ declare namespace Health {
|
|
562
562
|
*/
|
563
563
|
eventTypeCodes?: eventTypeList;
|
564
564
|
/**
|
565
|
-
* The Amazon Web Services
|
565
|
+
* The Amazon Web Services associated with the event. For example, EC2, RDS.
|
566
566
|
*/
|
567
567
|
services?: serviceList;
|
568
568
|
/**
|
@@ -609,7 +609,7 @@ declare namespace Health {
|
|
609
609
|
export type EventList = Event[];
|
610
610
|
export interface EventType {
|
611
611
|
/**
|
612
|
-
* The Amazon Web
|
612
|
+
* The Amazon Web Service that is affected by the event. For example, EC2, RDS.
|
613
613
|
*/
|
614
614
|
service?: service;
|
615
615
|
/**
|
@@ -629,7 +629,7 @@ declare namespace Health {
|
|
629
629
|
*/
|
630
630
|
eventTypeCodes?: EventTypeCodeList;
|
631
631
|
/**
|
632
|
-
* The Amazon Web Services
|
632
|
+
* The Amazon Web Services associated with the event. For example, EC2, RDS.
|
633
633
|
*/
|
634
634
|
services?: serviceList;
|
635
635
|
/**
|
@@ -652,7 +652,7 @@ declare namespace Health {
|
|
652
652
|
*/
|
653
653
|
errorName?: string;
|
654
654
|
/**
|
655
|
-
*
|
655
|
+
* A message that describes the error. Follow the error message and retry your request. For example, the InvalidAccountInputError error message appears if you call the DescribeAffectedEntitiesForOrganization operation and specify the AccountSpecific value for the EventScopeCode parameter, but don't specify an Amazon Web Services account.
|
656
656
|
*/
|
657
657
|
errorMessage?: string;
|
658
658
|
}
|
@@ -663,7 +663,7 @@ declare namespace Health {
|
|
663
663
|
*/
|
664
664
|
arn?: eventArn;
|
665
665
|
/**
|
666
|
-
* The Amazon Web
|
666
|
+
* The Amazon Web Service that is affected by the event, such as EC2 and RDS.
|
667
667
|
*/
|
668
668
|
service?: service;
|
669
669
|
/**
|
@@ -675,7 +675,7 @@ declare namespace Health {
|
|
675
675
|
*/
|
676
676
|
eventTypeCategory?: eventTypeCategory;
|
677
677
|
/**
|
678
|
-
* This parameter specifies if the Health event is a public Amazon Web
|
678
|
+
* This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event. If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty. If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response. If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.
|
679
679
|
*/
|
680
680
|
eventScopeCode?: eventScopeCode;
|
681
681
|
/**
|
@@ -740,7 +740,7 @@ declare namespace Health {
|
|
740
740
|
*/
|
741
741
|
awsAccountIds?: awsAccountIdsList;
|
742
742
|
/**
|
743
|
-
* The Amazon Web Services
|
743
|
+
* The Amazon Web Services associated with the event. For example, EC2, RDS.
|
744
744
|
*/
|
745
745
|
services?: serviceList;
|
746
746
|
/**
|
@@ -43,6 +43,14 @@ declare class IVSRealTime extends Service {
|
|
43
43
|
* Disconnects a specified participant and revokes the participant permanently from a specified stage.
|
44
44
|
*/
|
45
45
|
disconnectParticipant(callback?: (err: AWSError, data: IVSRealTime.Types.DisconnectParticipantResponse) => void): Request<IVSRealTime.Types.DisconnectParticipantResponse, AWSError>;
|
46
|
+
/**
|
47
|
+
* Gets information about the specified participant token.
|
48
|
+
*/
|
49
|
+
getParticipant(params: IVSRealTime.Types.GetParticipantRequest, callback?: (err: AWSError, data: IVSRealTime.Types.GetParticipantResponse) => void): Request<IVSRealTime.Types.GetParticipantResponse, AWSError>;
|
50
|
+
/**
|
51
|
+
* Gets information about the specified participant token.
|
52
|
+
*/
|
53
|
+
getParticipant(callback?: (err: AWSError, data: IVSRealTime.Types.GetParticipantResponse) => void): Request<IVSRealTime.Types.GetParticipantResponse, AWSError>;
|
46
54
|
/**
|
47
55
|
* Gets information for the specified stage.
|
48
56
|
*/
|
@@ -51,6 +59,38 @@ declare class IVSRealTime extends Service {
|
|
51
59
|
* Gets information for the specified stage.
|
52
60
|
*/
|
53
61
|
getStage(callback?: (err: AWSError, data: IVSRealTime.Types.GetStageResponse) => void): Request<IVSRealTime.Types.GetStageResponse, AWSError>;
|
62
|
+
/**
|
63
|
+
* Gets information for the specified stage session.
|
64
|
+
*/
|
65
|
+
getStageSession(params: IVSRealTime.Types.GetStageSessionRequest, callback?: (err: AWSError, data: IVSRealTime.Types.GetStageSessionResponse) => void): Request<IVSRealTime.Types.GetStageSessionResponse, AWSError>;
|
66
|
+
/**
|
67
|
+
* Gets information for the specified stage session.
|
68
|
+
*/
|
69
|
+
getStageSession(callback?: (err: AWSError, data: IVSRealTime.Types.GetStageSessionResponse) => void): Request<IVSRealTime.Types.GetStageSessionResponse, AWSError>;
|
70
|
+
/**
|
71
|
+
* Lists events for a specified participant that occurred during a specified stage session.
|
72
|
+
*/
|
73
|
+
listParticipantEvents(params: IVSRealTime.Types.ListParticipantEventsRequest, callback?: (err: AWSError, data: IVSRealTime.Types.ListParticipantEventsResponse) => void): Request<IVSRealTime.Types.ListParticipantEventsResponse, AWSError>;
|
74
|
+
/**
|
75
|
+
* Lists events for a specified participant that occurred during a specified stage session.
|
76
|
+
*/
|
77
|
+
listParticipantEvents(callback?: (err: AWSError, data: IVSRealTime.Types.ListParticipantEventsResponse) => void): Request<IVSRealTime.Types.ListParticipantEventsResponse, AWSError>;
|
78
|
+
/**
|
79
|
+
* Lists all participants in a specified stage session.
|
80
|
+
*/
|
81
|
+
listParticipants(params: IVSRealTime.Types.ListParticipantsRequest, callback?: (err: AWSError, data: IVSRealTime.Types.ListParticipantsResponse) => void): Request<IVSRealTime.Types.ListParticipantsResponse, AWSError>;
|
82
|
+
/**
|
83
|
+
* Lists all participants in a specified stage session.
|
84
|
+
*/
|
85
|
+
listParticipants(callback?: (err: AWSError, data: IVSRealTime.Types.ListParticipantsResponse) => void): Request<IVSRealTime.Types.ListParticipantsResponse, AWSError>;
|
86
|
+
/**
|
87
|
+
* Gets all sessions for a specified stage.
|
88
|
+
*/
|
89
|
+
listStageSessions(params: IVSRealTime.Types.ListStageSessionsRequest, callback?: (err: AWSError, data: IVSRealTime.Types.ListStageSessionsResponse) => void): Request<IVSRealTime.Types.ListStageSessionsResponse, AWSError>;
|
90
|
+
/**
|
91
|
+
* Gets all sessions for a specified stage.
|
92
|
+
*/
|
93
|
+
listStageSessions(callback?: (err: AWSError, data: IVSRealTime.Types.ListStageSessionsResponse) => void): Request<IVSRealTime.Types.ListStageSessionsResponse, AWSError>;
|
54
94
|
/**
|
55
95
|
* Gets summary information about all stages in your account, in the AWS region where the API request is processed.
|
56
96
|
*/
|
@@ -103,7 +143,7 @@ declare namespace IVSRealTime {
|
|
103
143
|
*/
|
104
144
|
capabilities?: ParticipantTokenCapabilities;
|
105
145
|
/**
|
106
|
-
* Duration (in minutes), after which the token expires. Default:
|
146
|
+
* Duration (in minutes), after which the token expires. Default: 720 (12 hours).
|
107
147
|
*/
|
108
148
|
duration?: ParticipantTokenDurationMinutes;
|
109
149
|
/**
|
@@ -156,7 +196,7 @@ declare namespace IVSRealTime {
|
|
156
196
|
export type DisconnectParticipantReason = string;
|
157
197
|
export interface DisconnectParticipantRequest {
|
158
198
|
/**
|
159
|
-
* Identifier of the participant to be disconnected. This is returned by CreateParticipantToken.
|
199
|
+
* Identifier of the participant to be disconnected. This is assigned by IVS and returned by CreateParticipantToken.
|
160
200
|
*/
|
161
201
|
participantId: ParticipantTokenId;
|
162
202
|
/**
|
@@ -170,6 +210,51 @@ declare namespace IVSRealTime {
|
|
170
210
|
}
|
171
211
|
export interface DisconnectParticipantResponse {
|
172
212
|
}
|
213
|
+
export interface Event {
|
214
|
+
/**
|
215
|
+
* If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken.
|
216
|
+
*/
|
217
|
+
errorCode?: EventErrorCode;
|
218
|
+
/**
|
219
|
+
* ISO 8601 timestamp (returned as a string) for when the event occurred.
|
220
|
+
*/
|
221
|
+
eventTime?: Time;
|
222
|
+
/**
|
223
|
+
* The name of the event.
|
224
|
+
*/
|
225
|
+
name?: EventName;
|
226
|
+
/**
|
227
|
+
* Unique identifier for the participant who triggered the event. This is assigned by IVS.
|
228
|
+
*/
|
229
|
+
participantId?: ParticipantId;
|
230
|
+
/**
|
231
|
+
* Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.
|
232
|
+
*/
|
233
|
+
remoteParticipantId?: ParticipantId;
|
234
|
+
}
|
235
|
+
export type EventErrorCode = "INSUFFICIENT_CAPABILITIES"|string;
|
236
|
+
export type EventList = Event[];
|
237
|
+
export type EventName = "JOINED"|"LEFT"|"PUBLISH_STARTED"|"PUBLISH_STOPPED"|"SUBSCRIBE_STARTED"|"SUBSCRIBE_STOPPED"|"PUBLISH_ERROR"|"SUBSCRIBE_ERROR"|"JOIN_ERROR"|string;
|
238
|
+
export interface GetParticipantRequest {
|
239
|
+
/**
|
240
|
+
* Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken.
|
241
|
+
*/
|
242
|
+
participantId: ParticipantId;
|
243
|
+
/**
|
244
|
+
* ID of a session within the stage.
|
245
|
+
*/
|
246
|
+
sessionId: StageSessionId;
|
247
|
+
/**
|
248
|
+
* Stage ARN.
|
249
|
+
*/
|
250
|
+
stageArn: StageArn;
|
251
|
+
}
|
252
|
+
export interface GetParticipantResponse {
|
253
|
+
/**
|
254
|
+
* The participant that is returned.
|
255
|
+
*/
|
256
|
+
participant?: Participant;
|
257
|
+
}
|
173
258
|
export interface GetStageRequest {
|
174
259
|
/**
|
175
260
|
* ARN of the stage for which the information is to be retrieved.
|
@@ -178,10 +263,122 @@ declare namespace IVSRealTime {
|
|
178
263
|
}
|
179
264
|
export interface GetStageResponse {
|
180
265
|
/**
|
181
|
-
*
|
266
|
+
* The stage that is returned.
|
182
267
|
*/
|
183
268
|
stage?: Stage;
|
184
269
|
}
|
270
|
+
export interface GetStageSessionRequest {
|
271
|
+
/**
|
272
|
+
* ID of a session within the stage.
|
273
|
+
*/
|
274
|
+
sessionId: StageSessionId;
|
275
|
+
/**
|
276
|
+
* ARN of the stage for which the information is to be retrieved.
|
277
|
+
*/
|
278
|
+
stageArn: StageArn;
|
279
|
+
}
|
280
|
+
export interface GetStageSessionResponse {
|
281
|
+
/**
|
282
|
+
* The stage session that is returned.
|
283
|
+
*/
|
284
|
+
stageSession?: StageSession;
|
285
|
+
}
|
286
|
+
export interface ListParticipantEventsRequest {
|
287
|
+
/**
|
288
|
+
* Maximum number of results to return. Default: 50.
|
289
|
+
*/
|
290
|
+
maxResults?: MaxParticipantEventResults;
|
291
|
+
/**
|
292
|
+
* The first participant to retrieve. This is used for pagination; see the nextToken response field.
|
293
|
+
*/
|
294
|
+
nextToken?: PaginationToken;
|
295
|
+
/**
|
296
|
+
* Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken.
|
297
|
+
*/
|
298
|
+
participantId: ParticipantId;
|
299
|
+
/**
|
300
|
+
* ID of a session within the stage.
|
301
|
+
*/
|
302
|
+
sessionId: StageSessionId;
|
303
|
+
/**
|
304
|
+
* Stage ARN.
|
305
|
+
*/
|
306
|
+
stageArn: StageArn;
|
307
|
+
}
|
308
|
+
export interface ListParticipantEventsResponse {
|
309
|
+
/**
|
310
|
+
* List of the matching events.
|
311
|
+
*/
|
312
|
+
events: EventList;
|
313
|
+
/**
|
314
|
+
* If there are more rooms than maxResults, use nextToken in the request to get the next set.
|
315
|
+
*/
|
316
|
+
nextToken?: PaginationToken;
|
317
|
+
}
|
318
|
+
export interface ListParticipantsRequest {
|
319
|
+
/**
|
320
|
+
* Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request.
|
321
|
+
*/
|
322
|
+
filterByPublished?: Published;
|
323
|
+
/**
|
324
|
+
* Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request.
|
325
|
+
*/
|
326
|
+
filterByState?: ParticipantState;
|
327
|
+
/**
|
328
|
+
* Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.
|
329
|
+
*/
|
330
|
+
filterByUserId?: UserId;
|
331
|
+
/**
|
332
|
+
* Maximum number of results to return. Default: 50.
|
333
|
+
*/
|
334
|
+
maxResults?: MaxParticipantResults;
|
335
|
+
/**
|
336
|
+
* The first participant to retrieve. This is used for pagination; see the nextToken response field.
|
337
|
+
*/
|
338
|
+
nextToken?: PaginationToken;
|
339
|
+
/**
|
340
|
+
* ID of the session within the stage.
|
341
|
+
*/
|
342
|
+
sessionId: StageSessionId;
|
343
|
+
/**
|
344
|
+
* Stage ARN.
|
345
|
+
*/
|
346
|
+
stageArn: StageArn;
|
347
|
+
}
|
348
|
+
export interface ListParticipantsResponse {
|
349
|
+
/**
|
350
|
+
* If there are more rooms than maxResults, use nextToken in the request to get the next set.
|
351
|
+
*/
|
352
|
+
nextToken?: PaginationToken;
|
353
|
+
/**
|
354
|
+
* List of the matching participants (summary information only).
|
355
|
+
*/
|
356
|
+
participants: ParticipantList;
|
357
|
+
}
|
358
|
+
export interface ListStageSessionsRequest {
|
359
|
+
/**
|
360
|
+
* Maximum number of results to return. Default: 50.
|
361
|
+
*/
|
362
|
+
maxResults?: MaxStageSessionResults;
|
363
|
+
/**
|
364
|
+
* The first stage to retrieve. This is used for pagination; see the nextToken response field.
|
365
|
+
*/
|
366
|
+
nextToken?: PaginationToken;
|
367
|
+
/**
|
368
|
+
* Stage ARN.
|
369
|
+
*/
|
370
|
+
stageArn: StageArn;
|
371
|
+
}
|
372
|
+
export interface ListStageSessionsResponse {
|
373
|
+
/**
|
374
|
+
* If there are more rooms than maxResults, use nextToken in the request to get the next set.
|
375
|
+
*/
|
376
|
+
nextToken?: PaginationToken;
|
377
|
+
/**
|
378
|
+
* List of matching stage sessions.
|
379
|
+
*/
|
380
|
+
stageSessions: StageSessionList;
|
381
|
+
}
|
185
382
|
export interface ListStagesRequest {
|
186
383
|
/**
|
187
384
|
* Maximum number of results to return. Default: 50.
|
@@ -214,8 +411,63 @@ declare namespace IVSRealTime {
|
|
214
411
|
*/
|
215
412
|
tags: Tags;
|
216
413
|
}
|
414
|
+
export type MaxParticipantEventResults = number;
|
415
|
+
export type MaxParticipantResults = number;
|
217
416
|
export type MaxStageResults = number;
|
417
|
+
export type MaxStageSessionResults = number;
|
218
418
|
export type PaginationToken = string;
|
419
|
+
export interface Participant {
|
420
|
+
/**
|
421
|
+
* Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
|
422
|
+
*/
|
423
|
+
attributes?: ParticipantAttributes;
|
424
|
+
/**
|
425
|
+
* ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
|
426
|
+
*/
|
427
|
+
firstJoinTime?: Time;
|
428
|
+
/**
|
429
|
+
* Unique identifier for this participant, assigned by IVS.
|
430
|
+
*/
|
431
|
+
participantId?: ParticipantId;
|
432
|
+
/**
|
433
|
+
* Whether the participant ever published to the stage session.
|
434
|
+
*/
|
435
|
+
published?: Published;
|
436
|
+
/**
|
437
|
+
* Whether the participant is connected to or disconnected from the stage.
|
438
|
+
*/
|
439
|
+
state?: ParticipantState;
|
440
|
+
/**
|
441
|
+
* Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
|
442
|
+
*/
|
443
|
+
userId?: UserId;
|
444
|
+
}
|
445
|
+
export type ParticipantAttributes = {[key: string]: String};
|
446
|
+
export type ParticipantId = string;
|
447
|
+
export type ParticipantList = ParticipantSummary[];
|
448
|
+
export type ParticipantState = "CONNECTED"|"DISCONNECTED"|string;
|
449
|
+
export interface ParticipantSummary {
|
450
|
+
/**
|
451
|
+
* ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
|
452
|
+
*/
|
453
|
+
firstJoinTime?: Time;
|
454
|
+
/**
|
455
|
+
* Unique identifier for this participant, assigned by IVS.
|
456
|
+
*/
|
457
|
+
participantId?: ParticipantId;
|
458
|
+
/**
|
459
|
+
* Whether the participant ever published to the stage session.
|
460
|
+
*/
|
461
|
+
published?: Published;
|
462
|
+
/**
|
463
|
+
* Whether the participant is connected to or disconnected from the stage.
|
464
|
+
*/
|
465
|
+
state?: ParticipantState;
|
466
|
+
/**
|
467
|
+
* Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
|
468
|
+
*/
|
469
|
+
userId?: UserId;
|
470
|
+
}
|
219
471
|
export interface ParticipantToken {
|
220
472
|
/**
|
221
473
|
* Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
|
@@ -226,7 +478,7 @@ declare namespace IVSRealTime {
|
|
226
478
|
*/
|
227
479
|
capabilities?: ParticipantTokenCapabilities;
|
228
480
|
/**
|
229
|
-
* Duration (in minutes), after which the participant token expires. Default:
|
481
|
+
* Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).
|
230
482
|
*/
|
231
483
|
duration?: ParticipantTokenDurationMinutes;
|
232
484
|
/**
|
@@ -242,7 +494,7 @@ declare namespace IVSRealTime {
|
|
242
494
|
*/
|
243
495
|
token?: ParticipantTokenString;
|
244
496
|
/**
|
245
|
-
*
|
497
|
+
* Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
|
246
498
|
*/
|
247
499
|
userId?: ParticipantTokenUserId;
|
248
500
|
}
|
@@ -259,11 +511,11 @@ declare namespace IVSRealTime {
|
|
259
511
|
*/
|
260
512
|
capabilities?: ParticipantTokenCapabilities;
|
261
513
|
/**
|
262
|
-
* Duration (in minutes), after which the corresponding participant token expires. Default:
|
514
|
+
* Duration (in minutes), after which the corresponding participant token expires. Default: 720 (12 hours).
|
263
515
|
*/
|
264
516
|
duration?: ParticipantTokenDurationMinutes;
|
265
517
|
/**
|
266
|
-
*
|
518
|
+
* Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
|
267
519
|
*/
|
268
520
|
userId?: ParticipantTokenUserId;
|
269
521
|
}
|
@@ -274,6 +526,7 @@ declare namespace IVSRealTime {
|
|
274
526
|
export type ParticipantTokenList = ParticipantToken[];
|
275
527
|
export type ParticipantTokenString = string;
|
276
528
|
export type ParticipantTokenUserId = string;
|
529
|
+
export type Published = boolean;
|
277
530
|
export type ResourceArn = string;
|
278
531
|
export interface Stage {
|
279
532
|
/**
|
@@ -295,7 +548,36 @@ declare namespace IVSRealTime {
|
|
295
548
|
}
|
296
549
|
export type StageArn = string;
|
297
550
|
export type StageName = string;
|
551
|
+
export interface StageSession {
|
552
|
+
/**
|
553
|
+
* ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.
|
554
|
+
*/
|
555
|
+
endTime?: Time;
|
556
|
+
/**
|
557
|
+
* ID of the session within the stage.
|
558
|
+
*/
|
559
|
+
sessionId?: StageSessionId;
|
560
|
+
/**
|
561
|
+
* ISO 8601 timestamp (returned as a string) when this stage session began.
|
562
|
+
*/
|
563
|
+
startTime?: Time;
|
564
|
+
}
|
298
565
|
export type StageSessionId = string;
|
566
|
+
export type StageSessionList = StageSessionSummary[];
|
567
|
+
export interface StageSessionSummary {
|
568
|
+
/**
|
569
|
+
* ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.
|
570
|
+
*/
|
571
|
+
endTime?: Time;
|
572
|
+
/**
|
573
|
+
* ID of the session within the stage.
|
574
|
+
*/
|
575
|
+
sessionId?: StageSessionId;
|
576
|
+
/**
|
577
|
+
* ISO 8601 timestamp (returned as a string) when this stage session began.
|
578
|
+
*/
|
579
|
+
startTime?: Time;
|
580
|
+
}
|
299
581
|
export interface StageSummary {
|
300
582
|
/**
|
301
583
|
* ID of the active session within the stage.
|
@@ -332,6 +614,7 @@ declare namespace IVSRealTime {
|
|
332
614
|
}
|
333
615
|
export type TagValue = string;
|
334
616
|
export type Tags = {[key: string]: TagValue};
|
617
|
+
export type Time = Date;
|
335
618
|
export interface UntagResourceRequest {
|
336
619
|
/**
|
337
620
|
* The ARN of the resource to be untagged. The ARN must be URL-encoded.
|
@@ -356,10 +639,11 @@ declare namespace IVSRealTime {
|
|
356
639
|
}
|
357
640
|
export interface UpdateStageResponse {
|
358
641
|
/**
|
359
|
-
* The updated stage.
|
642
|
+
* The updated stage.
|
360
643
|
*/
|
361
644
|
stage?: Stage;
|
362
645
|
}
|
646
|
+
export type UserId = string;
|
363
647
|
/**
|
364
648
|
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
|
365
649
|
*/
|