aws-sdk 2.1102.0 → 2.1105.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/CHANGELOG.md +18 -1
- package/README.md +1 -1
- package/apis/ec2-2016-11-15.min.json +863 -807
- package/apis/fms-2018-01-01.min.json +210 -83
- package/apis/fms-2018-01-01.paginators.json +6 -0
- package/apis/fsx-2018-03-01.min.json +3 -0
- package/apis/grafana-2020-08-18.min.json +117 -19
- package/apis/iot-data-2015-05-28.min.json +1 -1
- package/apis/metadata.json +4 -0
- package/apis/organizations-2016-11-28.min.json +77 -62
- package/apis/pinpoint-sms-voice-v2-2022-03-31.examples.json +5 -0
- package/apis/pinpoint-sms-voice-v2-2022-03-31.min.json +1681 -0
- package/apis/pinpoint-sms-voice-v2-2022-03-31.paginators.json +70 -0
- package/apis/pinpoint-sms-voice-v2-2022-03-31.waiters2.json +5 -0
- package/apis/route53-recovery-cluster-2019-12-02.min.json +39 -4
- package/apis/route53-recovery-cluster-2019-12-02.paginators.json +6 -0
- package/apis/workspaces-2015-04-08.min.json +195 -27
- package/clients/all.d.ts +1 -0
- package/clients/all.js +2 -1
- package/clients/auditmanager.d.ts +4 -4
- package/clients/cloudcontrol.d.ts +22 -22
- package/clients/databrew.d.ts +3 -3
- package/clients/ec2.d.ts +77 -3
- package/clients/fms.d.ts +222 -8
- package/clients/fsx.d.ts +12 -8
- package/clients/grafana.d.ts +81 -5
- package/clients/iot.d.ts +13 -13
- package/clients/iotdata.d.ts +7 -7
- package/clients/organizations.d.ts +144 -129
- package/clients/pinpointsmsvoicev2.d.ts +2367 -0
- package/clients/pinpointsmsvoicev2.js +19 -0
- package/clients/route53recoverycluster.d.ts +75 -12
- package/clients/workspaces.d.ts +239 -0
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +58 -14
- package/dist/aws-sdk.js +871 -811
- package/dist/aws-sdk.min.js +69 -69
- package/lib/config_service_placeholders.d.ts +2 -0
- package/lib/core.js +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
require('../lib/node_loader');
|
|
2
|
+
var AWS = require('../lib/core');
|
|
3
|
+
var Service = AWS.Service;
|
|
4
|
+
var apiLoader = AWS.apiLoader;
|
|
5
|
+
|
|
6
|
+
apiLoader.services['pinpointsmsvoicev2'] = {};
|
|
7
|
+
AWS.PinpointSMSVoiceV2 = Service.defineService('pinpointsmsvoicev2', ['2022-03-31']);
|
|
8
|
+
Object.defineProperty(apiLoader.services['pinpointsmsvoicev2'], '2022-03-31', {
|
|
9
|
+
get: function get() {
|
|
10
|
+
var model = require('../apis/pinpoint-sms-voice-v2-2022-03-31.min.json');
|
|
11
|
+
model.paginators = require('../apis/pinpoint-sms-voice-v2-2022-03-31.paginators.json').pagination;
|
|
12
|
+
model.waiters = require('../apis/pinpoint-sms-voice-v2-2022-03-31.waiters2.json').waiters;
|
|
13
|
+
return model;
|
|
14
|
+
},
|
|
15
|
+
enumerable: true,
|
|
16
|
+
configurable: true
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
module.exports = AWS.PinpointSMSVoiceV2;
|
|
@@ -12,54 +12,117 @@ declare class Route53RecoveryCluster extends Service {
|
|
|
12
12
|
constructor(options?: Route53RecoveryCluster.Types.ClientConfiguration)
|
|
13
13
|
config: Config & Route53RecoveryCluster.Types.ClientConfiguration;
|
|
14
14
|
/**
|
|
15
|
-
* Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When
|
|
15
|
+
* Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow. Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application. You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC. To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide. Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide: Viewing and updating routing control states Working with routing controls in Route 53 ARC
|
|
16
16
|
*/
|
|
17
17
|
getRoutingControlState(params: Route53RecoveryCluster.Types.GetRoutingControlStateRequest, callback?: (err: AWSError, data: Route53RecoveryCluster.Types.GetRoutingControlStateResponse) => void): Request<Route53RecoveryCluster.Types.GetRoutingControlStateResponse, AWSError>;
|
|
18
18
|
/**
|
|
19
|
-
* Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When
|
|
19
|
+
* Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow. Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application. You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC. To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide. Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide: Viewing and updating routing control states Working with routing controls in Route 53 ARC
|
|
20
20
|
*/
|
|
21
21
|
getRoutingControlState(callback?: (err: AWSError, data: Route53RecoveryCluster.Types.GetRoutingControlStateResponse) => void): Request<Route53RecoveryCluster.Types.GetRoutingControlStateResponse, AWSError>;
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls. If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists all the routing controls in the cluster. A routing control is a simple on/off switch in Route 53 ARC that you can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow. Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application. You must specify Regional endpoints when you work with API cluster operations to use this API operation to list routing controls in Route 53 ARC. Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide: Viewing and updating routing control states Working with routing controls in Route 53 ARC
|
|
24
|
+
*/
|
|
25
|
+
listRoutingControls(params: Route53RecoveryCluster.Types.ListRoutingControlsRequest, callback?: (err: AWSError, data: Route53RecoveryCluster.Types.ListRoutingControlsResponse) => void): Request<Route53RecoveryCluster.Types.ListRoutingControlsResponse, AWSError>;
|
|
26
|
+
/**
|
|
27
|
+
* List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls. If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists all the routing controls in the cluster. A routing control is a simple on/off switch in Route 53 ARC that you can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow. Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application. You must specify Regional endpoints when you work with API cluster operations to use this API operation to list routing controls in Route 53 ARC. Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide: Viewing and updating routing control states Working with routing controls in Route 53 ARC
|
|
28
|
+
*/
|
|
29
|
+
listRoutingControls(callback?: (err: AWSError, data: Route53RecoveryCluster.Types.ListRoutingControlsResponse) => void): Request<Route53RecoveryCluster.Types.ListRoutingControlsResponse, AWSError>;
|
|
30
|
+
/**
|
|
31
|
+
* Set the state of the routing control to reroute traffic. You can set the value to be On or Off. When the state is On, traffic flows to a cell. When the state is Off, traffic does not flow. With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application. The SafetyRulesToOverride property enables you override one or more safety rules and update routing control states. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide. You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC. To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide. Viewing and updating routing control states Working with routing controls overall
|
|
24
32
|
*/
|
|
25
33
|
updateRoutingControlState(params: Route53RecoveryCluster.Types.UpdateRoutingControlStateRequest, callback?: (err: AWSError, data: Route53RecoveryCluster.Types.UpdateRoutingControlStateResponse) => void): Request<Route53RecoveryCluster.Types.UpdateRoutingControlStateResponse, AWSError>;
|
|
26
34
|
/**
|
|
27
|
-
* Set the state of the routing control to reroute traffic. You can set the value to be On or Off. When the state is On, traffic flows to a cell. When
|
|
35
|
+
* Set the state of the routing control to reroute traffic. You can set the value to be On or Off. When the state is On, traffic flows to a cell. When the state is Off, traffic does not flow. With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application. The SafetyRulesToOverride property enables you override one or more safety rules and update routing control states. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide. You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC. To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide. Viewing and updating routing control states Working with routing controls overall
|
|
28
36
|
*/
|
|
29
37
|
updateRoutingControlState(callback?: (err: AWSError, data: Route53RecoveryCluster.Types.UpdateRoutingControlStateResponse) => void): Request<Route53RecoveryCluster.Types.UpdateRoutingControlStateResponse, AWSError>;
|
|
30
38
|
/**
|
|
31
|
-
* Set multiple routing control states. You can set the value for each state to be On or Off. When the state is On, traffic flows to a cell. When it's Off, traffic does not flow. With
|
|
39
|
+
* Set multiple routing control states. You can set the value for each state to be On or Off. When the state is On, traffic flows to a cell. When it's Off, traffic does not flow. With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application. The SafetyRulesToOverride property enables you override one or more safety rules and update routing control states. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide. You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC. To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide. Viewing and updating routing control states Working with routing controls overall
|
|
32
40
|
*/
|
|
33
41
|
updateRoutingControlStates(params: Route53RecoveryCluster.Types.UpdateRoutingControlStatesRequest, callback?: (err: AWSError, data: Route53RecoveryCluster.Types.UpdateRoutingControlStatesResponse) => void): Request<Route53RecoveryCluster.Types.UpdateRoutingControlStatesResponse, AWSError>;
|
|
34
42
|
/**
|
|
35
|
-
* Set multiple routing control states. You can set the value for each state to be On or Off. When the state is On, traffic flows to a cell. When it's Off, traffic does not flow. With
|
|
43
|
+
* Set multiple routing control states. You can set the value for each state to be On or Off. When the state is On, traffic flows to a cell. When it's Off, traffic does not flow. With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application. The SafetyRulesToOverride property enables you override one or more safety rules and update routing control states. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide. You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC. To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide. Viewing and updating routing control states Working with routing controls overall
|
|
36
44
|
*/
|
|
37
45
|
updateRoutingControlStates(callback?: (err: AWSError, data: Route53RecoveryCluster.Types.UpdateRoutingControlStatesResponse) => void): Request<Route53RecoveryCluster.Types.UpdateRoutingControlStatesResponse, AWSError>;
|
|
38
46
|
}
|
|
39
47
|
declare namespace Route53RecoveryCluster {
|
|
40
48
|
export type Arn = string;
|
|
41
49
|
export type Arns = Arn[];
|
|
50
|
+
export type ControlPanelName = string;
|
|
42
51
|
export interface GetRoutingControlStateRequest {
|
|
43
52
|
/**
|
|
44
|
-
* The Amazon Resource
|
|
53
|
+
* The Amazon Resource Name (ARN) for the routing control that you want to get the state for.
|
|
45
54
|
*/
|
|
46
55
|
RoutingControlArn: Arn;
|
|
47
56
|
}
|
|
48
57
|
export interface GetRoutingControlStateResponse {
|
|
49
58
|
/**
|
|
50
|
-
* The Amazon Resource
|
|
59
|
+
* The Amazon Resource Name (ARN) of the response.
|
|
51
60
|
*/
|
|
52
61
|
RoutingControlArn: Arn;
|
|
53
62
|
/**
|
|
54
63
|
* The state of the routing control.
|
|
55
64
|
*/
|
|
56
65
|
RoutingControlState: RoutingControlState;
|
|
66
|
+
/**
|
|
67
|
+
* The routing control name.
|
|
68
|
+
*/
|
|
69
|
+
RoutingControlName?: RoutingControlName;
|
|
70
|
+
}
|
|
71
|
+
export interface ListRoutingControlsRequest {
|
|
72
|
+
/**
|
|
73
|
+
* The Amazon Resource Name (ARN) of the control panel of the routing controls to list.
|
|
74
|
+
*/
|
|
75
|
+
ControlPanelArn?: Arn;
|
|
76
|
+
/**
|
|
77
|
+
* The token for the next set of results. You receive this token from a previous call.
|
|
78
|
+
*/
|
|
79
|
+
NextToken?: PageToken;
|
|
80
|
+
/**
|
|
81
|
+
* The number of routing controls objects that you want to return with this call. The default value is 500.
|
|
82
|
+
*/
|
|
83
|
+
MaxResults?: MaxResults;
|
|
84
|
+
}
|
|
85
|
+
export interface ListRoutingControlsResponse {
|
|
86
|
+
/**
|
|
87
|
+
* The list of routing controls.
|
|
88
|
+
*/
|
|
89
|
+
RoutingControls: RoutingControls;
|
|
90
|
+
/**
|
|
91
|
+
* The token for the next set of results. You receive this token from a previous call.
|
|
92
|
+
*/
|
|
93
|
+
NextToken?: PageToken;
|
|
94
|
+
}
|
|
95
|
+
export type MaxResults = number;
|
|
96
|
+
export type PageToken = string;
|
|
97
|
+
export interface RoutingControl {
|
|
98
|
+
/**
|
|
99
|
+
* The Amazon Resource Name (ARN) of the control panel where the routing control is located.
|
|
100
|
+
*/
|
|
101
|
+
ControlPanelArn?: Arn;
|
|
102
|
+
/**
|
|
103
|
+
* The name of the control panel where the routing control is located.
|
|
104
|
+
*/
|
|
105
|
+
ControlPanelName?: ControlPanelName;
|
|
106
|
+
/**
|
|
107
|
+
* The Amazon Resource Name (ARN) of the routing control.
|
|
108
|
+
*/
|
|
109
|
+
RoutingControlArn?: Arn;
|
|
110
|
+
/**
|
|
111
|
+
* The name of the routing control.
|
|
112
|
+
*/
|
|
113
|
+
RoutingControlName?: RoutingControlName;
|
|
114
|
+
/**
|
|
115
|
+
* The current state of the routing control. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow.
|
|
116
|
+
*/
|
|
117
|
+
RoutingControlState?: RoutingControlState;
|
|
57
118
|
}
|
|
119
|
+
export type RoutingControlName = string;
|
|
58
120
|
export type RoutingControlState = "On"|"Off"|string;
|
|
121
|
+
export type RoutingControls = RoutingControl[];
|
|
59
122
|
export type UpdateRoutingControlStateEntries = UpdateRoutingControlStateEntry[];
|
|
60
123
|
export interface UpdateRoutingControlStateEntry {
|
|
61
124
|
/**
|
|
62
|
-
* The Amazon Resource
|
|
125
|
+
* The Amazon Resource Name (ARN) for a routing control state entry.
|
|
63
126
|
*/
|
|
64
127
|
RoutingControlArn: Arn;
|
|
65
128
|
/**
|
|
@@ -69,7 +132,7 @@ declare namespace Route53RecoveryCluster {
|
|
|
69
132
|
}
|
|
70
133
|
export interface UpdateRoutingControlStateRequest {
|
|
71
134
|
/**
|
|
72
|
-
* The Amazon Resource
|
|
135
|
+
* The Amazon Resource Name (ARN) for the routing control that you want to update the state for.
|
|
73
136
|
*/
|
|
74
137
|
RoutingControlArn: Arn;
|
|
75
138
|
/**
|
|
@@ -77,7 +140,7 @@ declare namespace Route53RecoveryCluster {
|
|
|
77
140
|
*/
|
|
78
141
|
RoutingControlState: RoutingControlState;
|
|
79
142
|
/**
|
|
80
|
-
* The Amazon Resource
|
|
143
|
+
* The Amazon Resource Names (ARNs) for the safety rules that you want to override when you're updating the state of a routing control. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.
|
|
81
144
|
*/
|
|
82
145
|
SafetyRulesToOverride?: Arns;
|
|
83
146
|
}
|
|
@@ -89,7 +152,7 @@ declare namespace Route53RecoveryCluster {
|
|
|
89
152
|
*/
|
|
90
153
|
UpdateRoutingControlStateEntries: UpdateRoutingControlStateEntries;
|
|
91
154
|
/**
|
|
92
|
-
* The Amazon Resource
|
|
155
|
+
* The Amazon Resource Names (ARNs) for the safety rules that you want to override when you're updating routing control states. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.
|
|
93
156
|
*/
|
|
94
157
|
SafetyRulesToOverride?: Arns;
|
|
95
158
|
}
|
package/clients/workspaces.d.ts
CHANGED
|
@@ -99,6 +99,14 @@ declare class WorkSpaces extends Service {
|
|
|
99
99
|
* Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created.
|
|
100
100
|
*/
|
|
101
101
|
createWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.CreateWorkspacesResult) => void): Request<WorkSpaces.Types.CreateWorkspacesResult, AWSError>;
|
|
102
|
+
/**
|
|
103
|
+
* Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you delete your customized client branding, your login portal reverts to the default client branding.
|
|
104
|
+
*/
|
|
105
|
+
deleteClientBranding(params: WorkSpaces.Types.DeleteClientBrandingRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DeleteClientBrandingResult) => void): Request<WorkSpaces.Types.DeleteClientBrandingResult, AWSError>;
|
|
106
|
+
/**
|
|
107
|
+
* Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you delete your customized client branding, your login portal reverts to the default client branding.
|
|
108
|
+
*/
|
|
109
|
+
deleteClientBranding(callback?: (err: AWSError, data: WorkSpaces.Types.DeleteClientBrandingResult) => void): Request<WorkSpaces.Types.DeleteClientBrandingResult, AWSError>;
|
|
102
110
|
/**
|
|
103
111
|
* Deletes a client-add-in for Amazon Connect that is configured within a directory.
|
|
104
112
|
*/
|
|
@@ -171,6 +179,14 @@ declare class WorkSpaces extends Service {
|
|
|
171
179
|
* Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
|
|
172
180
|
*/
|
|
173
181
|
describeAccountModifications(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountModificationsResult) => void): Request<WorkSpaces.Types.DescribeAccountModificationsResult, AWSError>;
|
|
182
|
+
/**
|
|
183
|
+
* Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. Only device types that have branding information configured will be shown in the response.
|
|
184
|
+
*/
|
|
185
|
+
describeClientBranding(params: WorkSpaces.Types.DescribeClientBrandingRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeClientBrandingResult) => void): Request<WorkSpaces.Types.DescribeClientBrandingResult, AWSError>;
|
|
186
|
+
/**
|
|
187
|
+
* Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. Only device types that have branding information configured will be shown in the response.
|
|
188
|
+
*/
|
|
189
|
+
describeClientBranding(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeClientBrandingResult) => void): Request<WorkSpaces.Types.DescribeClientBrandingResult, AWSError>;
|
|
174
190
|
/**
|
|
175
191
|
* Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
|
|
176
192
|
*/
|
|
@@ -291,6 +307,14 @@ declare class WorkSpaces extends Service {
|
|
|
291
307
|
* Disassociates the specified IP access control group from the specified directory.
|
|
292
308
|
*/
|
|
293
309
|
disassociateIpGroups(callback?: (err: AWSError, data: WorkSpaces.Types.DisassociateIpGroupsResult) => void): Request<WorkSpaces.Types.DisassociateIpGroupsResult, AWSError>;
|
|
310
|
+
/**
|
|
311
|
+
* Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience You must specify at least one platform type when importing client branding. You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests. In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both. Imported data can take up to a minute to appear in the WorkSpaces client.
|
|
312
|
+
*/
|
|
313
|
+
importClientBranding(params: WorkSpaces.Types.ImportClientBrandingRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ImportClientBrandingResult) => void): Request<WorkSpaces.Types.ImportClientBrandingResult, AWSError>;
|
|
314
|
+
/**
|
|
315
|
+
* Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience You must specify at least one platform type when importing client branding. You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests. In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both. Imported data can take up to a minute to appear in the WorkSpaces client.
|
|
316
|
+
*/
|
|
317
|
+
importClientBranding(callback?: (err: AWSError, data: WorkSpaces.Types.ImportClientBrandingResult) => void): Request<WorkSpaces.Types.ImportClientBrandingResult, AWSError>;
|
|
294
318
|
/**
|
|
295
319
|
* Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
|
|
296
320
|
*/
|
|
@@ -559,6 +583,11 @@ declare namespace WorkSpaces {
|
|
|
559
583
|
export type BundleIdList = BundleId[];
|
|
560
584
|
export type BundleList = WorkspaceBundle[];
|
|
561
585
|
export type BundleOwner = string;
|
|
586
|
+
export type ClientDeviceType = "DeviceTypeWindows"|"DeviceTypeOsx"|"DeviceTypeAndroid"|"DeviceTypeIos"|"DeviceTypeLinux"|"DeviceTypeWeb"|string;
|
|
587
|
+
export type ClientDeviceTypeList = ClientDeviceType[];
|
|
588
|
+
export type ClientEmail = string;
|
|
589
|
+
export type ClientLocale = string;
|
|
590
|
+
export type ClientLoginMessage = string;
|
|
562
591
|
export interface ClientProperties {
|
|
563
592
|
/**
|
|
564
593
|
* Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
|
|
@@ -576,6 +605,7 @@ declare namespace WorkSpaces {
|
|
|
576
605
|
*/
|
|
577
606
|
ClientProperties?: ClientProperties;
|
|
578
607
|
}
|
|
608
|
+
export type ClientUrl = string;
|
|
579
609
|
export type Compute = "VALUE"|"STANDARD"|"PERFORMANCE"|"POWER"|"GRAPHICS"|"POWERPRO"|"GRAPHICSPRO"|string;
|
|
580
610
|
export interface ComputeType {
|
|
581
611
|
/**
|
|
@@ -831,6 +861,51 @@ declare namespace WorkSpaces {
|
|
|
831
861
|
export type DedicatedTenancyModificationStateEnum = "PENDING"|"COMPLETED"|"FAILED"|string;
|
|
832
862
|
export type DedicatedTenancySupportEnum = "ENABLED"|string;
|
|
833
863
|
export type DedicatedTenancySupportResultEnum = "ENABLED"|"DISABLED"|string;
|
|
864
|
+
export interface DefaultClientBrandingAttributes {
|
|
865
|
+
/**
|
|
866
|
+
* The logo URL. This is the link where users can download the logo image. The only supported image format is .png.
|
|
867
|
+
*/
|
|
868
|
+
LogoUrl?: ClientUrl;
|
|
869
|
+
/**
|
|
870
|
+
* The support email. The company's customer support email address. In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both. The default email is workspaces-feedback@amazon.com.
|
|
871
|
+
*/
|
|
872
|
+
SupportEmail?: ClientEmail;
|
|
873
|
+
/**
|
|
874
|
+
* The support link. The link for the company's customer support page for their WorkSpace. In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both. The default support link is workspaces-feedback@amazon.com.
|
|
875
|
+
*/
|
|
876
|
+
SupportLink?: ClientUrl;
|
|
877
|
+
/**
|
|
878
|
+
* The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
|
|
879
|
+
*/
|
|
880
|
+
ForgotPasswordLink?: ClientUrl;
|
|
881
|
+
/**
|
|
882
|
+
* The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US.
|
|
883
|
+
*/
|
|
884
|
+
LoginMessage?: LoginMessage;
|
|
885
|
+
}
|
|
886
|
+
export interface DefaultImportClientBrandingAttributes {
|
|
887
|
+
/**
|
|
888
|
+
* The logo. This is the link where users can download the logo image. The only image format accepted is .png.
|
|
889
|
+
*/
|
|
890
|
+
Logo?: DefaultLogo;
|
|
891
|
+
/**
|
|
892
|
+
* The support email. The company's customer support email address. In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both. The default email is workspaces-feedback@amazon.com.
|
|
893
|
+
*/
|
|
894
|
+
SupportEmail?: ClientEmail;
|
|
895
|
+
/**
|
|
896
|
+
* The support link. The link for the company's customer support page for their WorkSpace. In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both. The default support link is workspaces-feedback@amazon.com.
|
|
897
|
+
*/
|
|
898
|
+
SupportLink?: ClientUrl;
|
|
899
|
+
/**
|
|
900
|
+
* The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
|
|
901
|
+
*/
|
|
902
|
+
ForgotPasswordLink?: ClientUrl;
|
|
903
|
+
/**
|
|
904
|
+
* The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US.
|
|
905
|
+
*/
|
|
906
|
+
LoginMessage?: LoginMessage;
|
|
907
|
+
}
|
|
908
|
+
export type DefaultLogo = Buffer|Uint8Array|Blob|string;
|
|
834
909
|
export type DefaultOu = string;
|
|
835
910
|
export interface DefaultWorkspaceCreationProperties {
|
|
836
911
|
/**
|
|
@@ -858,6 +933,18 @@ declare namespace WorkSpaces {
|
|
|
858
933
|
*/
|
|
859
934
|
EnableMaintenanceMode?: BooleanObject;
|
|
860
935
|
}
|
|
936
|
+
export interface DeleteClientBrandingRequest {
|
|
937
|
+
/**
|
|
938
|
+
* The directory identifier of the WorkSpace for which you want to delete client branding.
|
|
939
|
+
*/
|
|
940
|
+
ResourceId: DirectoryId;
|
|
941
|
+
/**
|
|
942
|
+
* The device type for which you want to delete client branding.
|
|
943
|
+
*/
|
|
944
|
+
Platforms: ClientDeviceTypeList;
|
|
945
|
+
}
|
|
946
|
+
export interface DeleteClientBrandingResult {
|
|
947
|
+
}
|
|
861
948
|
export interface DeleteConnectClientAddInRequest {
|
|
862
949
|
/**
|
|
863
950
|
* The identifier of the client add-in to delete.
|
|
@@ -950,6 +1037,38 @@ declare namespace WorkSpaces {
|
|
|
950
1037
|
*/
|
|
951
1038
|
DedicatedTenancyManagementCidrRange?: DedicatedTenancyManagementCidrRange;
|
|
952
1039
|
}
|
|
1040
|
+
export interface DescribeClientBrandingRequest {
|
|
1041
|
+
/**
|
|
1042
|
+
* The directory identifier of the WorkSpace for which you want to view client branding information.
|
|
1043
|
+
*/
|
|
1044
|
+
ResourceId: DirectoryId;
|
|
1045
|
+
}
|
|
1046
|
+
export interface DescribeClientBrandingResult {
|
|
1047
|
+
/**
|
|
1048
|
+
* The branding information for Windows devices.
|
|
1049
|
+
*/
|
|
1050
|
+
DeviceTypeWindows?: DefaultClientBrandingAttributes;
|
|
1051
|
+
/**
|
|
1052
|
+
* The branding information for macOS devices.
|
|
1053
|
+
*/
|
|
1054
|
+
DeviceTypeOsx?: DefaultClientBrandingAttributes;
|
|
1055
|
+
/**
|
|
1056
|
+
* The branding information for Android devices.
|
|
1057
|
+
*/
|
|
1058
|
+
DeviceTypeAndroid?: DefaultClientBrandingAttributes;
|
|
1059
|
+
/**
|
|
1060
|
+
* The branding information for iOS devices.
|
|
1061
|
+
*/
|
|
1062
|
+
DeviceTypeIos?: IosClientBrandingAttributes;
|
|
1063
|
+
/**
|
|
1064
|
+
* The branding information for Linux devices.
|
|
1065
|
+
*/
|
|
1066
|
+
DeviceTypeLinux?: DefaultClientBrandingAttributes;
|
|
1067
|
+
/**
|
|
1068
|
+
* The branding information for Web access.
|
|
1069
|
+
*/
|
|
1070
|
+
DeviceTypeWeb?: DefaultClientBrandingAttributes;
|
|
1071
|
+
}
|
|
953
1072
|
export interface DescribeClientPropertiesRequest {
|
|
954
1073
|
/**
|
|
955
1074
|
* The resource identifier, in the form of directory IDs.
|
|
@@ -1324,6 +1443,62 @@ declare namespace WorkSpaces {
|
|
|
1324
1443
|
}
|
|
1325
1444
|
export type ImagePermissions = ImagePermission[];
|
|
1326
1445
|
export type ImageType = "OWNED"|"SHARED"|string;
|
|
1446
|
+
export interface ImportClientBrandingRequest {
|
|
1447
|
+
/**
|
|
1448
|
+
* The directory identifier of the WorkSpace for which you want to import client branding.
|
|
1449
|
+
*/
|
|
1450
|
+
ResourceId: DirectoryId;
|
|
1451
|
+
/**
|
|
1452
|
+
* The branding information to import for Windows devices.
|
|
1453
|
+
*/
|
|
1454
|
+
DeviceTypeWindows?: DefaultImportClientBrandingAttributes;
|
|
1455
|
+
/**
|
|
1456
|
+
* The branding information to import for macOS devices.
|
|
1457
|
+
*/
|
|
1458
|
+
DeviceTypeOsx?: DefaultImportClientBrandingAttributes;
|
|
1459
|
+
/**
|
|
1460
|
+
* The branding information to import for Android devices.
|
|
1461
|
+
*/
|
|
1462
|
+
DeviceTypeAndroid?: DefaultImportClientBrandingAttributes;
|
|
1463
|
+
/**
|
|
1464
|
+
* The branding information to import for iOS devices.
|
|
1465
|
+
*/
|
|
1466
|
+
DeviceTypeIos?: IosImportClientBrandingAttributes;
|
|
1467
|
+
/**
|
|
1468
|
+
* The branding information to import for Linux devices.
|
|
1469
|
+
*/
|
|
1470
|
+
DeviceTypeLinux?: DefaultImportClientBrandingAttributes;
|
|
1471
|
+
/**
|
|
1472
|
+
* The branding information to import for web access.
|
|
1473
|
+
*/
|
|
1474
|
+
DeviceTypeWeb?: DefaultImportClientBrandingAttributes;
|
|
1475
|
+
}
|
|
1476
|
+
export interface ImportClientBrandingResult {
|
|
1477
|
+
/**
|
|
1478
|
+
* The branding information configured for Windows devices.
|
|
1479
|
+
*/
|
|
1480
|
+
DeviceTypeWindows?: DefaultClientBrandingAttributes;
|
|
1481
|
+
/**
|
|
1482
|
+
* The branding information configured for macOS devices.
|
|
1483
|
+
*/
|
|
1484
|
+
DeviceTypeOsx?: DefaultClientBrandingAttributes;
|
|
1485
|
+
/**
|
|
1486
|
+
* The branding information configured for Android devices.
|
|
1487
|
+
*/
|
|
1488
|
+
DeviceTypeAndroid?: DefaultClientBrandingAttributes;
|
|
1489
|
+
/**
|
|
1490
|
+
* The branding information configured for iOS devices.
|
|
1491
|
+
*/
|
|
1492
|
+
DeviceTypeIos?: IosClientBrandingAttributes;
|
|
1493
|
+
/**
|
|
1494
|
+
* The branding information configured for Linux devices.
|
|
1495
|
+
*/
|
|
1496
|
+
DeviceTypeLinux?: DefaultClientBrandingAttributes;
|
|
1497
|
+
/**
|
|
1498
|
+
* The branding information configured for web access.
|
|
1499
|
+
*/
|
|
1500
|
+
DeviceTypeWeb?: DefaultClientBrandingAttributes;
|
|
1501
|
+
}
|
|
1327
1502
|
export interface ImportWorkspaceImageRequest {
|
|
1328
1503
|
/**
|
|
1329
1504
|
* The identifier of the EC2 image.
|
|
@@ -1356,6 +1531,69 @@ declare namespace WorkSpaces {
|
|
|
1356
1531
|
*/
|
|
1357
1532
|
ImageId?: WorkspaceImageId;
|
|
1358
1533
|
}
|
|
1534
|
+
export type Ios2XLogo = Buffer|Uint8Array|Blob|string;
|
|
1535
|
+
export type Ios3XLogo = Buffer|Uint8Array|Blob|string;
|
|
1536
|
+
export interface IosClientBrandingAttributes {
|
|
1537
|
+
/**
|
|
1538
|
+
* The logo. This is the link where users can download the logo image. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point.
|
|
1539
|
+
*/
|
|
1540
|
+
LogoUrl?: ClientUrl;
|
|
1541
|
+
/**
|
|
1542
|
+
* The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
|
|
1543
|
+
*/
|
|
1544
|
+
Logo2xUrl?: ClientUrl;
|
|
1545
|
+
/**
|
|
1546
|
+
* The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x). For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
|
|
1547
|
+
*/
|
|
1548
|
+
Logo3xUrl?: ClientUrl;
|
|
1549
|
+
/**
|
|
1550
|
+
* The support email. The company's customer support email address. In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both. The default email is workspaces-feedback@amazon.com.
|
|
1551
|
+
*/
|
|
1552
|
+
SupportEmail?: ClientEmail;
|
|
1553
|
+
/**
|
|
1554
|
+
* The support link. The link for the company's customer support page for their WorkSpace. In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both. The default support link is workspaces-feedback@amazon.com.
|
|
1555
|
+
*/
|
|
1556
|
+
SupportLink?: ClientUrl;
|
|
1557
|
+
/**
|
|
1558
|
+
* The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
|
|
1559
|
+
*/
|
|
1560
|
+
ForgotPasswordLink?: ClientUrl;
|
|
1561
|
+
/**
|
|
1562
|
+
* The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US.
|
|
1563
|
+
*/
|
|
1564
|
+
LoginMessage?: LoginMessage;
|
|
1565
|
+
}
|
|
1566
|
+
export interface IosImportClientBrandingAttributes {
|
|
1567
|
+
/**
|
|
1568
|
+
* The logo. This is the link where users can download the logo image. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point.
|
|
1569
|
+
*/
|
|
1570
|
+
Logo?: IosLogo;
|
|
1571
|
+
/**
|
|
1572
|
+
* The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
|
|
1573
|
+
*/
|
|
1574
|
+
Logo2x?: Ios2XLogo;
|
|
1575
|
+
/**
|
|
1576
|
+
* The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x). For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
|
|
1577
|
+
*/
|
|
1578
|
+
Logo3x?: Ios3XLogo;
|
|
1579
|
+
/**
|
|
1580
|
+
* The support email. The company's customer support email address. In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both. The default email is workspaces-feedback@amazon.com.
|
|
1581
|
+
*/
|
|
1582
|
+
SupportEmail?: ClientEmail;
|
|
1583
|
+
/**
|
|
1584
|
+
* The support link. The link for the company's customer support page for their WorkSpace. In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both. The default support link is workspaces-feedback@amazon.com.
|
|
1585
|
+
*/
|
|
1586
|
+
SupportLink?: ClientUrl;
|
|
1587
|
+
/**
|
|
1588
|
+
* The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
|
|
1589
|
+
*/
|
|
1590
|
+
ForgotPasswordLink?: ClientUrl;
|
|
1591
|
+
/**
|
|
1592
|
+
* The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US.
|
|
1593
|
+
*/
|
|
1594
|
+
LoginMessage?: LoginMessage;
|
|
1595
|
+
}
|
|
1596
|
+
export type IosLogo = Buffer|Uint8Array|Blob|string;
|
|
1359
1597
|
export type IpAddress = string;
|
|
1360
1598
|
export type IpGroupDesc = string;
|
|
1361
1599
|
export type IpGroupId = string;
|
|
@@ -1400,6 +1638,7 @@ declare namespace WorkSpaces {
|
|
|
1400
1638
|
*/
|
|
1401
1639
|
NextToken?: PaginationToken;
|
|
1402
1640
|
}
|
|
1641
|
+
export type LoginMessage = {[key: string]: ClientLoginMessage};
|
|
1403
1642
|
export type ManagementCidrRangeConstraint = string;
|
|
1404
1643
|
export type ManagementCidrRangeMaxResults = number;
|
|
1405
1644
|
export interface MigrateWorkspaceRequest {
|