@scaleway/sdk 2.57.0 → 2.59.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/dist/api/audit_trail/v1alpha1/index.gen.d.ts +1 -1
- package/dist/api/audit_trail/v1alpha1/marshalling.gen.cjs +12 -0
- package/dist/api/audit_trail/v1alpha1/marshalling.gen.js +12 -0
- package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +28 -0
- package/dist/api/iam/v1alpha1/api.gen.cjs +63 -7
- package/dist/api/iam/v1alpha1/api.gen.d.ts +35 -8
- package/dist/api/iam/v1alpha1/api.gen.js +64 -8
- package/dist/api/iam/v1alpha1/index.gen.d.ts +1 -1
- package/dist/api/iam/v1alpha1/marshalling.gen.cjs +23 -0
- package/dist/api/iam/v1alpha1/marshalling.gen.d.ts +4 -1
- package/dist/api/iam/v1alpha1/marshalling.gen.js +23 -0
- package/dist/api/iam/v1alpha1/types.gen.d.ts +31 -3
- package/dist/api/iam/v1alpha1/validation-rules.gen.cjs +8 -0
- package/dist/api/iam/v1alpha1/validation-rules.gen.d.ts +7 -0
- package/dist/api/iam/v1alpha1/validation-rules.gen.js +9 -1
- package/dist/api/ipam/v1/api.gen.cjs +1 -0
- package/dist/api/ipam/v1/api.gen.js +1 -0
- package/dist/api/ipam/v1/types.gen.d.ts +5 -0
- package/dist/api/k8s/v1/marshalling.gen.cjs +1 -2
- package/dist/api/k8s/v1/marshalling.gen.js +1 -2
- package/dist/api/k8s/v1/types.gen.d.ts +2 -7
- package/dist/api/marketplace/v2/types.gen.d.ts +5 -2
- package/dist/api/mnq/v1beta1/api.gen.cjs +47 -42
- package/dist/api/mnq/v1beta1/api.gen.d.ts +51 -49
- package/dist/api/mnq/v1beta1/api.gen.js +47 -42
- package/dist/api/mnq/v1beta1/types.gen.d.ts +37 -32
- package/dist/api/tem/v1alpha1/types.gen.d.ts +1 -1
- package/dist/api/vpcgw/index.gen.cjs +2 -0
- package/dist/api/vpcgw/index.gen.d.ts +1 -0
- package/dist/api/vpcgw/index.gen.js +3 -1
- package/dist/api/vpcgw/v2/api.gen.cjs +517 -0
- package/dist/api/vpcgw/v2/api.gen.d.ts +267 -0
- package/dist/api/vpcgw/v2/api.gen.js +517 -0
- package/dist/api/vpcgw/v2/content.gen.cjs +15 -0
- package/dist/api/vpcgw/v2/content.gen.d.ts +5 -0
- package/dist/api/vpcgw/v2/content.gen.js +15 -0
- package/dist/api/vpcgw/v2/index.gen.cjs +7 -0
- package/dist/api/vpcgw/v2/index.gen.d.ts +3 -0
- package/dist/api/vpcgw/v2/index.gen.js +7 -0
- package/dist/api/vpcgw/v2/marshalling.gen.cjs +259 -0
- package/dist/api/vpcgw/v2/marshalling.gen.d.ts +22 -0
- package/dist/api/vpcgw/v2/marshalling.gen.js +259 -0
- package/dist/api/vpcgw/v2/types.gen.d.ts +450 -0
- package/dist/api/webhosting/v1/api.gen.cjs +41 -2
- package/dist/api/webhosting/v1/api.gen.d.ts +26 -2
- package/dist/api/webhosting/v1/api.gen.js +42 -3
- package/dist/api/webhosting/v1/index.gen.cjs +1 -0
- package/dist/api/webhosting/v1/index.gen.d.ts +2 -2
- package/dist/api/webhosting/v1/index.gen.js +2 -1
- package/dist/api/webhosting/v1/marshalling.gen.cjs +137 -51
- package/dist/api/webhosting/v1/marshalling.gen.d.ts +4 -1
- package/dist/api/webhosting/v1/marshalling.gen.js +138 -52
- package/dist/api/webhosting/v1/types.gen.d.ts +144 -60
- package/dist/scw/constants.cjs +1 -1
- package/dist/scw/constants.d.ts +2 -2
- package/dist/scw/constants.js +1 -1
- package/package.json +2 -2
|
@@ -9,7 +9,7 @@ export type ListPermissionSetsRequestOrderBy = 'name_asc' | 'name_desc' | 'creat
|
|
|
9
9
|
export type ListPoliciesRequestOrderBy = 'policy_name_asc' | 'policy_name_desc' | 'created_at_asc' | 'created_at_desc';
|
|
10
10
|
export type ListQuotaRequestOrderBy = 'name_asc' | 'name_desc';
|
|
11
11
|
export type ListSSHKeysRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'updated_at_asc' | 'updated_at_desc' | 'name_asc' | 'name_desc';
|
|
12
|
-
export type ListUsersRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'updated_at_asc' | 'updated_at_desc' | 'email_asc' | 'email_desc' | 'last_login_asc' | 'last_login_desc';
|
|
12
|
+
export type ListUsersRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'updated_at_asc' | 'updated_at_desc' | 'email_asc' | 'email_desc' | 'last_login_asc' | 'last_login_desc' | 'username_asc' | 'username_desc';
|
|
13
13
|
export type LogAction = 'unknown_action' | 'created' | 'updated' | 'deleted';
|
|
14
14
|
export type LogResourceType = 'unknown_resource_type' | 'api_key' | 'user' | 'application' | 'group' | 'policy';
|
|
15
15
|
export type PermissionSetScopeType = 'unknown_scope_type' | 'projects' | 'organization' | 'account_root_user';
|
|
@@ -494,7 +494,7 @@ export type CreateUserRequest = {
|
|
|
494
494
|
/** Tags associated with the user. */
|
|
495
495
|
tags?: string[];
|
|
496
496
|
/**
|
|
497
|
-
*
|
|
497
|
+
* Details of IAM member. Private Beta feature.
|
|
498
498
|
*
|
|
499
499
|
* One-of ('type'): at most one of 'email', 'member' could be set.
|
|
500
500
|
*/
|
|
@@ -555,6 +555,10 @@ export type GetLogRequest = {
|
|
|
555
555
|
/** ID of the log. */
|
|
556
556
|
logId: string;
|
|
557
557
|
};
|
|
558
|
+
export type GetOrganizationSecuritySettingsRequest = {
|
|
559
|
+
/** ID of the Organization. */
|
|
560
|
+
organizationId?: string;
|
|
561
|
+
};
|
|
558
562
|
export type GetPolicyRequest = {
|
|
559
563
|
/** Id of policy to search. */
|
|
560
564
|
policyId: string;
|
|
@@ -843,6 +847,14 @@ export type LockUserRequest = {
|
|
|
843
847
|
/** ID of the user to lock. */
|
|
844
848
|
userId: string;
|
|
845
849
|
};
|
|
850
|
+
export interface OrganizationSecuritySettings {
|
|
851
|
+
/** Defines whether password renewal is enforced during first login. */
|
|
852
|
+
enforcePasswordRenewal: boolean;
|
|
853
|
+
/** Duration of the grace period to renew password or enable MFA. */
|
|
854
|
+
gracePeriodDuration?: string;
|
|
855
|
+
/** Number of login attempts before the account is locked. */
|
|
856
|
+
loginAttemptsBeforeLocked: number;
|
|
857
|
+
}
|
|
846
858
|
export type RemoveGroupMemberRequest = {
|
|
847
859
|
/** ID of the group. */
|
|
848
860
|
groupId: string;
|
|
@@ -909,6 +921,16 @@ export type UpdateGroupRequest = {
|
|
|
909
921
|
/** New tags for the group (maximum of 10 tags). */
|
|
910
922
|
tags?: string[];
|
|
911
923
|
};
|
|
924
|
+
export type UpdateOrganizationSecuritySettingsRequest = {
|
|
925
|
+
/** ID of the Organization. */
|
|
926
|
+
organizationId?: string;
|
|
927
|
+
/** Defines whether password renewal is enforced during first login. */
|
|
928
|
+
enforcePasswordRenewal?: boolean;
|
|
929
|
+
/** Duration of the grace period to renew password or enable MFA. */
|
|
930
|
+
gracePeriodDuration?: string;
|
|
931
|
+
/** Number of login attempts before the account is locked. */
|
|
932
|
+
loginAttemptsBeforeLocked?: number;
|
|
933
|
+
};
|
|
912
934
|
export type UpdatePolicyRequest = {
|
|
913
935
|
/** Id of policy to update. */
|
|
914
936
|
policyId: string;
|
|
@@ -970,6 +992,12 @@ export type UpdateUserRequest = {
|
|
|
970
992
|
userId: string;
|
|
971
993
|
/** New tags for the user (maximum of 10 tags). */
|
|
972
994
|
tags?: string[];
|
|
973
|
-
/**
|
|
995
|
+
/** IAM member email. */
|
|
974
996
|
email?: string;
|
|
975
997
|
};
|
|
998
|
+
export type UpdateUserUsernameRequest = {
|
|
999
|
+
/** ID of the user to update. */
|
|
1000
|
+
userId: string;
|
|
1001
|
+
/** The new username. */
|
|
1002
|
+
username: string;
|
|
1003
|
+
};
|
|
@@ -236,6 +236,13 @@ const UpdateUserPasswordRequest = {
|
|
|
236
236
|
minLength: 1
|
|
237
237
|
}
|
|
238
238
|
};
|
|
239
|
+
const UpdateUserUsernameRequest = {
|
|
240
|
+
username: {
|
|
241
|
+
maxLength: 64,
|
|
242
|
+
minLength: 2,
|
|
243
|
+
pattern: /^[a-zA-Z0-9._-]+$/
|
|
244
|
+
}
|
|
245
|
+
};
|
|
239
246
|
exports.CreateAPIKeyRequest = CreateAPIKeyRequest;
|
|
240
247
|
exports.CreateApplicationRequest = CreateApplicationRequest;
|
|
241
248
|
exports.CreateGroupRequest = CreateGroupRequest;
|
|
@@ -261,3 +268,4 @@ exports.UpdateGroupRequest = UpdateGroupRequest;
|
|
|
261
268
|
exports.UpdatePolicyRequest = UpdatePolicyRequest;
|
|
262
269
|
exports.UpdateSSHKeyRequest = UpdateSSHKeyRequest;
|
|
263
270
|
exports.UpdateUserPasswordRequest = UpdateUserPasswordRequest;
|
|
271
|
+
exports.UpdateUserUsernameRequest = UpdateUserUsernameRequest;
|
|
@@ -234,6 +234,13 @@ const UpdateUserPasswordRequest = {
|
|
|
234
234
|
minLength: 1
|
|
235
235
|
}
|
|
236
236
|
};
|
|
237
|
+
const UpdateUserUsernameRequest = {
|
|
238
|
+
username: {
|
|
239
|
+
maxLength: 64,
|
|
240
|
+
minLength: 2,
|
|
241
|
+
pattern: /^[a-zA-Z0-9._-]+$/
|
|
242
|
+
}
|
|
243
|
+
};
|
|
237
244
|
export {
|
|
238
245
|
CreateAPIKeyRequest,
|
|
239
246
|
CreateApplicationRequest,
|
|
@@ -259,5 +266,6 @@ export {
|
|
|
259
266
|
UpdateGroupRequest,
|
|
260
267
|
UpdatePolicyRequest,
|
|
261
268
|
UpdateSSHKeyRequest,
|
|
262
|
-
UpdateUserPasswordRequest
|
|
269
|
+
UpdateUserPasswordRequest,
|
|
270
|
+
UpdateUserUsernameRequest
|
|
263
271
|
};
|
|
@@ -96,6 +96,7 @@ class API extends api.API {
|
|
|
96
96
|
],
|
|
97
97
|
["project_id", request.projectId],
|
|
98
98
|
["resource_id", request.resourceId],
|
|
99
|
+
["resource_ids", request.resourceIds],
|
|
99
100
|
["resource_name", request.resourceName],
|
|
100
101
|
["resource_type", request.resourceType],
|
|
101
102
|
["resource_types", request.resourceTypes],
|
|
@@ -94,6 +94,7 @@ class API extends API$1 {
|
|
|
94
94
|
],
|
|
95
95
|
["project_id", request.projectId],
|
|
96
96
|
["resource_id", request.resourceId],
|
|
97
|
+
["resource_ids", request.resourceIds],
|
|
97
98
|
["resource_name", request.resourceName],
|
|
98
99
|
["resource_type", request.resourceType],
|
|
99
100
|
["resource_types", request.resourceTypes],
|
|
@@ -191,6 +191,11 @@ export type ListIPsRequest = {
|
|
|
191
191
|
* returned.
|
|
192
192
|
*/
|
|
193
193
|
resourceId?: string;
|
|
194
|
+
/**
|
|
195
|
+
* Resource IDs to filter for. Only IPs attached to at least one of these
|
|
196
|
+
* resources will be returned.
|
|
197
|
+
*/
|
|
198
|
+
resourceIds?: string[];
|
|
194
199
|
/**
|
|
195
200
|
* Resource type to filter for. Only IPs attached to this type of resource
|
|
196
201
|
* will be returned.
|
|
@@ -128,6 +128,7 @@ const unmarshalCluster = (data) => {
|
|
|
128
128
|
);
|
|
129
129
|
}
|
|
130
130
|
return {
|
|
131
|
+
aclAvailable: data.acl_available,
|
|
131
132
|
admissionPlugins: data.admission_plugins,
|
|
132
133
|
apiserverCertSans: data.apiserver_cert_sans,
|
|
133
134
|
autoUpgrade: data.auto_upgrade ? unmarshalClusterAutoUpgrade(data.auto_upgrade) : void 0,
|
|
@@ -139,7 +140,6 @@ const unmarshalCluster = (data) => {
|
|
|
139
140
|
description: data.description,
|
|
140
141
|
dnsWildcard: data.dns_wildcard,
|
|
141
142
|
featureGates: data.feature_gates,
|
|
142
|
-
fullVpcIntegratonEnabled: data.full_vpc_integraton_enabled,
|
|
143
143
|
id: data.id,
|
|
144
144
|
name: data.name,
|
|
145
145
|
openIdConnectConfig: data.open_id_connect_config ? unmarshalClusterOpenIDConnectConfig(data.open_id_connect_config) : void 0,
|
|
@@ -147,7 +147,6 @@ const unmarshalCluster = (data) => {
|
|
|
147
147
|
privateNetworkId: data.private_network_id,
|
|
148
148
|
projectId: data.project_id,
|
|
149
149
|
region: data.region,
|
|
150
|
-
routedIpEnabled: data.routed_ip_enabled,
|
|
151
150
|
sbsCsiEnabled: data.sbs_csi_enabled,
|
|
152
151
|
status: data.status,
|
|
153
152
|
tags: data.tags,
|
|
@@ -126,6 +126,7 @@ const unmarshalCluster = (data) => {
|
|
|
126
126
|
);
|
|
127
127
|
}
|
|
128
128
|
return {
|
|
129
|
+
aclAvailable: data.acl_available,
|
|
129
130
|
admissionPlugins: data.admission_plugins,
|
|
130
131
|
apiserverCertSans: data.apiserver_cert_sans,
|
|
131
132
|
autoUpgrade: data.auto_upgrade ? unmarshalClusterAutoUpgrade(data.auto_upgrade) : void 0,
|
|
@@ -137,7 +138,6 @@ const unmarshalCluster = (data) => {
|
|
|
137
138
|
description: data.description,
|
|
138
139
|
dnsWildcard: data.dns_wildcard,
|
|
139
140
|
featureGates: data.feature_gates,
|
|
140
|
-
fullVpcIntegratonEnabled: data.full_vpc_integraton_enabled,
|
|
141
141
|
id: data.id,
|
|
142
142
|
name: data.name,
|
|
143
143
|
openIdConnectConfig: data.open_id_connect_config ? unmarshalClusterOpenIDConnectConfig(data.open_id_connect_config) : void 0,
|
|
@@ -145,7 +145,6 @@ const unmarshalCluster = (data) => {
|
|
|
145
145
|
privateNetworkId: data.private_network_id,
|
|
146
146
|
projectId: data.project_id,
|
|
147
147
|
region: data.region,
|
|
148
|
-
routedIpEnabled: data.routed_ip_enabled,
|
|
149
148
|
sbsCsiEnabled: data.sbs_csi_enabled,
|
|
150
149
|
status: data.status,
|
|
151
150
|
tags: data.tags,
|
|
@@ -474,18 +474,13 @@ export interface Cluster {
|
|
|
474
474
|
privateNetworkId?: string;
|
|
475
475
|
/** Date on which it will be possible to switch to a smaller offer. */
|
|
476
476
|
commitmentEndsAt?: Date;
|
|
477
|
-
/**
|
|
478
|
-
* @deprecated Defines whether routed IPs are enabled for nodes of this
|
|
479
|
-
* cluster.
|
|
480
|
-
*/
|
|
481
|
-
routedIpEnabled?: boolean;
|
|
482
477
|
/**
|
|
483
478
|
* @deprecated Defines whether the SBS-enabled CSI starting from v0.3 is
|
|
484
479
|
* installed on the cluster.
|
|
485
480
|
*/
|
|
486
481
|
sbsCsiEnabled?: boolean;
|
|
487
|
-
/** @deprecated Defines whether
|
|
488
|
-
|
|
482
|
+
/** @deprecated Defines whether ACL is available on the cluster. */
|
|
483
|
+
aclAvailable?: boolean;
|
|
489
484
|
}
|
|
490
485
|
export interface Node {
|
|
491
486
|
/** Node ID. */
|
|
@@ -25,7 +25,10 @@ export interface Image {
|
|
|
25
25
|
updatedAt?: Date;
|
|
26
26
|
/** Expiration date of this image. */
|
|
27
27
|
validUntil?: Date;
|
|
28
|
-
/**
|
|
28
|
+
/**
|
|
29
|
+
* Typically an identifier for a distribution (ex. "ubuntu_focal"). This label
|
|
30
|
+
* can be used in the image field of the server creation request.
|
|
31
|
+
*/
|
|
29
32
|
label: string;
|
|
30
33
|
}
|
|
31
34
|
export interface LocalImage {
|
|
@@ -37,7 +40,7 @@ export interface LocalImage {
|
|
|
37
40
|
arch: string;
|
|
38
41
|
/** Availability Zone where this local image is available. */
|
|
39
42
|
zone: Zone;
|
|
40
|
-
/**
|
|
43
|
+
/** This label can be used in the image field of the server creation request. */
|
|
41
44
|
label: string;
|
|
42
45
|
/** Type of this local image. */
|
|
43
46
|
type: LocalImageType;
|
|
@@ -159,7 +159,8 @@ class NatsAPI extends api.API {
|
|
|
159
159
|
[
|
|
160
160
|
"page_size",
|
|
161
161
|
request.pageSize ?? this.client.settings.defaultPageSize
|
|
162
|
-
]
|
|
162
|
+
],
|
|
163
|
+
["project_id", request.projectId]
|
|
163
164
|
)
|
|
164
165
|
},
|
|
165
166
|
marshalling_gen.unmarshalListNatsCredentialsResponse
|
|
@@ -183,9 +184,10 @@ class SnsAPI extends api.API {
|
|
|
183
184
|
/** Lists the available regions of the API. */
|
|
184
185
|
static LOCALITIES = ["fr-par", "nl-ams"];
|
|
185
186
|
/**
|
|
186
|
-
* Activate
|
|
187
|
-
*
|
|
188
|
-
* and
|
|
187
|
+
* Activate Topics and Events. Activate Topics and Events for the specified
|
|
188
|
+
* Project ID. Topics and Events must be activated before any usage.
|
|
189
|
+
* Activating Topics and Events does not trigger any billing, and you can
|
|
190
|
+
* deactivate at any time.
|
|
189
191
|
*
|
|
190
192
|
* @param request - The request {@link SnsApiActivateSnsRequest}
|
|
191
193
|
* @returns A Promise of SnsInfo
|
|
@@ -202,8 +204,9 @@ class SnsAPI extends api.API {
|
|
|
202
204
|
marshalling_gen.unmarshalSnsInfo
|
|
203
205
|
);
|
|
204
206
|
/**
|
|
205
|
-
* Get
|
|
206
|
-
* Informations include the activation status and
|
|
207
|
+
* Get Topics and Events info. Retrieve the Topics and Events information of
|
|
208
|
+
* the specified Project ID. Informations include the activation status and
|
|
209
|
+
* the Topics and Events API endpoint URL.
|
|
207
210
|
*
|
|
208
211
|
* @param request - The request {@link SnsApiGetSnsInfoRequest}
|
|
209
212
|
* @returns A Promise of SnsInfo
|
|
@@ -220,9 +223,9 @@ class SnsAPI extends api.API {
|
|
|
220
223
|
marshalling_gen.unmarshalSnsInfo
|
|
221
224
|
);
|
|
222
225
|
/**
|
|
223
|
-
* Deactivate
|
|
224
|
-
*
|
|
225
|
-
* force_delete parameter.
|
|
226
|
+
* Deactivate Topics and Events. Deactivate Topics and Events for the
|
|
227
|
+
* specified Project ID. You must delete all topics and credentials before
|
|
228
|
+
* this call or you need to set the force_delete parameter.
|
|
226
229
|
*
|
|
227
230
|
* @param request - The request {@link SnsApiDeactivateSnsRequest}
|
|
228
231
|
* @returns A Promise of SnsInfo
|
|
@@ -239,9 +242,9 @@ class SnsAPI extends api.API {
|
|
|
239
242
|
marshalling_gen.unmarshalSnsInfo
|
|
240
243
|
);
|
|
241
244
|
/**
|
|
242
|
-
* Create
|
|
243
|
-
* Project ID. Credentials give the bearer
|
|
244
|
-
* permissions can be defined granularly.
|
|
245
|
+
* Create Topics and Events credentials. Create a set of credentials for
|
|
246
|
+
* Topics and Events, specified by a Project ID. Credentials give the bearer
|
|
247
|
+
* access to topics, and the level of permissions can be defined granularly.
|
|
245
248
|
*
|
|
246
249
|
* @param request - The request {@link SnsApiCreateSnsCredentialsRequest}
|
|
247
250
|
* @returns A Promise of SnsCredentials
|
|
@@ -261,9 +264,10 @@ class SnsAPI extends api.API {
|
|
|
261
264
|
marshalling_gen.unmarshalSnsCredentials
|
|
262
265
|
);
|
|
263
266
|
/**
|
|
264
|
-
* Delete
|
|
265
|
-
* credentials ID. Deleting credentials is
|
|
266
|
-
* The credentials can then no longer be
|
|
267
|
+
* Delete Topics and Events credentials. Delete a set of Topics and Events
|
|
268
|
+
* credentials, specified by their credentials ID. Deleting credentials is
|
|
269
|
+
* irreversible and cannot be undone. The credentials can then no longer be
|
|
270
|
+
* used to access Topics and Events.
|
|
267
271
|
*
|
|
268
272
|
* @param request - The request {@link SnsApiDeleteSnsCredentialsRequest}
|
|
269
273
|
*/
|
|
@@ -272,8 +276,8 @@ class SnsAPI extends api.API {
|
|
|
272
276
|
path: `/mnq/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/sns-credentials/${marshalling.validatePathParam("snsCredentialsId", request.snsCredentialsId)}`
|
|
273
277
|
});
|
|
274
278
|
/**
|
|
275
|
-
* Update
|
|
276
|
-
* credentials' name, or their permissions.
|
|
279
|
+
* Update Topics and Events credentials. Update a set of Topics and Events
|
|
280
|
+
* credentials. You can update the credentials' name, or their permissions.
|
|
277
281
|
*
|
|
278
282
|
* @param request - The request {@link SnsApiUpdateSnsCredentialsRequest}
|
|
279
283
|
* @returns A Promise of SnsCredentials
|
|
@@ -293,9 +297,9 @@ class SnsAPI extends api.API {
|
|
|
293
297
|
marshalling_gen.unmarshalSnsCredentials
|
|
294
298
|
);
|
|
295
299
|
/**
|
|
296
|
-
* Get
|
|
297
|
-
* the `credentials_id`. The credentials themselves, as well as
|
|
298
|
-
* (name, project ID etc), are returned in the response.
|
|
300
|
+
* Get Topics and Events credentials. Retrieve an existing set of credentials,
|
|
301
|
+
* identified by the `credentials_id`. The credentials themselves, as well as
|
|
302
|
+
* their metadata (name, project ID etc), are returned in the response.
|
|
299
303
|
*
|
|
300
304
|
* @param request - The request {@link SnsApiGetSnsCredentialsRequest}
|
|
301
305
|
* @returns A Promise of SnsCredentials
|
|
@@ -324,9 +328,9 @@ class SnsAPI extends api.API {
|
|
|
324
328
|
marshalling_gen.unmarshalListSnsCredentialsResponse
|
|
325
329
|
);
|
|
326
330
|
/**
|
|
327
|
-
* List
|
|
328
|
-
* region. The response contains only the
|
|
329
|
-
* the credentials themselves.
|
|
331
|
+
* List Topics and Events credentials. List existing Topics and Events
|
|
332
|
+
* credentials in the specified region. The response contains only the
|
|
333
|
+
* metadata for the credentials, not the credentials themselves.
|
|
330
334
|
*
|
|
331
335
|
* @param request - The request {@link SnsApiListSnsCredentialsRequest}
|
|
332
336
|
* @returns A Promise of ListSnsCredentialsResponse
|
|
@@ -341,10 +345,10 @@ class SqsAPI extends api.API {
|
|
|
341
345
|
/** Lists the available regions of the API. */
|
|
342
346
|
static LOCALITIES = ["fr-par", "nl-ams"];
|
|
343
347
|
/**
|
|
344
|
-
* Activate
|
|
345
|
-
* activated before any usage such as creating credentials and queues.
|
|
346
|
-
* Activating
|
|
347
|
-
* time.
|
|
348
|
+
* Activate Queues. Activate Queues for the specified Project ID. Queues must
|
|
349
|
+
* be activated before any usage such as creating credentials and queues.
|
|
350
|
+
* Activating Queues does not trigger any billing, and you can deactivate at
|
|
351
|
+
* any time.
|
|
348
352
|
*
|
|
349
353
|
* @param request - The request {@link SqsApiActivateSqsRequest}
|
|
350
354
|
* @returns A Promise of SqsInfo
|
|
@@ -361,8 +365,9 @@ class SqsAPI extends api.API {
|
|
|
361
365
|
marshalling_gen.unmarshalSqsInfo
|
|
362
366
|
);
|
|
363
367
|
/**
|
|
364
|
-
* Get
|
|
365
|
-
* Informations include the activation status and the
|
|
368
|
+
* Get Queues info. Retrieve the Queues information of the specified Project
|
|
369
|
+
* ID. Informations include the activation status and the Queues API endpoint
|
|
370
|
+
* URL.
|
|
366
371
|
*
|
|
367
372
|
* @param request - The request {@link SqsApiGetSqsInfoRequest}
|
|
368
373
|
* @returns A Promise of SqsInfo
|
|
@@ -379,7 +384,7 @@ class SqsAPI extends api.API {
|
|
|
379
384
|
marshalling_gen.unmarshalSqsInfo
|
|
380
385
|
);
|
|
381
386
|
/**
|
|
382
|
-
* Deactivate
|
|
387
|
+
* Deactivate Queues. Deactivate Queues for the specified Project ID. You must
|
|
383
388
|
* delete all queues and credentials before this call or you need to set the
|
|
384
389
|
* force_delete parameter.
|
|
385
390
|
*
|
|
@@ -398,9 +403,9 @@ class SqsAPI extends api.API {
|
|
|
398
403
|
marshalling_gen.unmarshalSqsInfo
|
|
399
404
|
);
|
|
400
405
|
/**
|
|
401
|
-
* Create
|
|
402
|
-
* Project ID. Credentials give the bearer access to queues,
|
|
403
|
-
* permissions can be defined granularly.
|
|
406
|
+
* Create Queues credentials. Create a set of credentials for Queues,
|
|
407
|
+
* specified by a Project ID. Credentials give the bearer access to queues,
|
|
408
|
+
* and the level of permissions can be defined granularly.
|
|
404
409
|
*
|
|
405
410
|
* @param request - The request {@link SqsApiCreateSqsCredentialsRequest}
|
|
406
411
|
* @returns A Promise of SqsCredentials
|
|
@@ -420,9 +425,9 @@ class SqsAPI extends api.API {
|
|
|
420
425
|
marshalling_gen.unmarshalSqsCredentials
|
|
421
426
|
);
|
|
422
427
|
/**
|
|
423
|
-
* Delete
|
|
424
|
-
* credentials ID. Deleting credentials is irreversible and cannot be
|
|
425
|
-
* The credentials can then no longer be used to access
|
|
428
|
+
* Delete Queues credentials. Delete a set of Queues credentials, specified by
|
|
429
|
+
* their credentials ID. Deleting credentials is irreversible and cannot be
|
|
430
|
+
* undone. The credentials can then no longer be used to access Queues.
|
|
426
431
|
*
|
|
427
432
|
* @param request - The request {@link SqsApiDeleteSqsCredentialsRequest}
|
|
428
433
|
*/
|
|
@@ -431,8 +436,8 @@ class SqsAPI extends api.API {
|
|
|
431
436
|
path: `/mnq/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/sqs-credentials/${marshalling.validatePathParam("sqsCredentialsId", request.sqsCredentialsId)}`
|
|
432
437
|
});
|
|
433
438
|
/**
|
|
434
|
-
* Update
|
|
435
|
-
* credentials' name, or their permissions.
|
|
439
|
+
* Update Queues credentials. Update a set of Queues credentials. You can
|
|
440
|
+
* update the credentials' name, or their permissions.
|
|
436
441
|
*
|
|
437
442
|
* @param request - The request {@link SqsApiUpdateSqsCredentialsRequest}
|
|
438
443
|
* @returns A Promise of SqsCredentials
|
|
@@ -452,9 +457,9 @@ class SqsAPI extends api.API {
|
|
|
452
457
|
marshalling_gen.unmarshalSqsCredentials
|
|
453
458
|
);
|
|
454
459
|
/**
|
|
455
|
-
* Get
|
|
456
|
-
* the `credentials_id`. The credentials themselves, as well as their
|
|
457
|
-
* (name, project ID etc), are returned in the response.
|
|
460
|
+
* Get Queues credentials. Retrieve an existing set of credentials, identified
|
|
461
|
+
* by the `credentials_id`. The credentials themselves, as well as their
|
|
462
|
+
* metadata (name, project ID etc), are returned in the response.
|
|
458
463
|
*
|
|
459
464
|
* @param request - The request {@link SqsApiGetSqsCredentialsRequest}
|
|
460
465
|
* @returns A Promise of SqsCredentials
|
|
@@ -483,7 +488,7 @@ class SqsAPI extends api.API {
|
|
|
483
488
|
marshalling_gen.unmarshalListSqsCredentialsResponse
|
|
484
489
|
);
|
|
485
490
|
/**
|
|
486
|
-
* List
|
|
491
|
+
* List Queues credentials. List existing Queues credentials in the specified
|
|
487
492
|
* region. The response contains only the metadata for the credentials, not
|
|
488
493
|
* the credentials themselves.
|
|
489
494
|
*
|