@aws-sdk/client-qapps 3.701.0 → 3.702.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.
Files changed (6) hide show
  1. package/dist-types/commands/CreatePresignedUrlCommand.d.ts +59 -0
  2. package/dist-types/commands/DescribeQAppPermissionsCommand.d.ts +34 -0
  3. package/dist-types/commands/GetQAppSessionMetadataCommand.d.ts +25 -0
  4. package/dist-types/commands/UpdateQAppPermissionsCommand.d.ts +73 -0
  5. package/dist-types/commands/UpdateQAppSessionMetadataCommand.d.ts +30 -0
  6. package/package.json +1 -1
package/dist-types/commands/CreatePresignedUrlCommand.d.ts CHANGED
@@ -86,6 +86,65 @@ declare const CreatePresignedUrlCommand_base: {
86
86
  * <p>Base exception class for all service exceptions from QApps service.</p>
87
87
  *
88
88
  * @public
89
+ * @example Upload a file to a specific session
90
+ * ```javascript
91
+ * //
92
+ * const input = {
93
+ * "appId": "4263767c-d889-4cb2-a8f6-8b649bc66af0",
94
+ * "cardId": "82f69028-22a9-4bea-8727-0eabf58e9fed",
95
+ * "fileContentsSha256": "myMXwslBoXkTDQ0olhq1QsiHRWWL4yj1V0IuoK+PYOg=",
96
+ * "fileName": "myFile.txt",
97
+ * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
98
+ * "scope": "SESSION",
99
+ * "sessionId": "4f0e5b87-9d38-41cd-9eb4-ebce2f2917cc"
100
+ * };
101
+ * const command = new CreatePresignedUrlCommand(input);
102
+ * const response = await client.send(command);
103
+ * /* response ==
104
+ * {
105
+ * "fileId": "412aa1b4-341c-45af-936d-da52f8a1a3b4",
106
+ * "presignedUrl": "https://presign-test-omg-6f98533b-3f9f-4e8a-8183-63793b9ffef0.s3.us-west-2.amazonaws.com/",
107
+ * "presignedUrlExpiration": "2024-09-14T00:11:54.232Z",
108
+ * "presignedUrlFields": {
109
+ * "x-amz-checksum-sha256": "fmHCdgdPjOGub9TVZ4NIOpAYP4UlIOaPRUwHw8nihR4=",
110
+ * "x-amz-server-side-encryption": "aws:kms",
111
+ * "x-amz-server-side-encryption-aws-kms-key-id": "0a6a474b-f2ca-46ea-9e72-deea9077d92f",
112
+ * "x-amz-server-side-encryption-context": "eyJzb21ldGhpbmciOiJ0aGVyZSJ9"
113
+ * }
114
+ * }
115
+ * *\/
116
+ * // example id: example-1
117
+ * ```
118
+ *
119
+ * @example Upload a file into a application
120
+ * ```javascript
121
+ * //
122
+ * const input = {
123
+ * "appId": "4263767c-d889-4cb2-a8f6-8b649bc66af0",
124
+ * "cardId": "7a11f34b-42d4-4bc8-b668-ae4a788dae1e",
125
+ * "fileContentsSha256": "myMXwslBoXkTDQ0olhq1QsiHRWWL4yj1V0IuoK+PYOg=",
126
+ * "fileName": "anApplicationFile.txt",
127
+ * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
128
+ * "scope": "APPLICATION"
129
+ * };
130
+ * const command = new CreatePresignedUrlCommand(input);
131
+ * const response = await client.send(command);
132
+ * /* response ==
133
+ * {
134
+ * "fileId": "412aa1b4-341c-45af-936d-da52f8a1a3b4",
135
+ * "presignedUrl": "https://presign-test-omg-6f98533b-3f9f-4e8a-8183-63793b9ffef0.s3.us-west-2.amazonaws.com/",
136
+ * "presignedUrlExpiration": "2024-09-14T00:11:54.232Z",
137
+ * "presignedUrlFields": {
138
+ * "x-amz-checksum-sha256": "fmHCdgdPjOGub9TVZ4NIOpAYP4UlIOaPRUwHw8nihR4=",
139
+ * "x-amz-server-side-encryption": "aws:kms",
140
+ * "x-amz-server-side-encryption-aws-kms-key-id": "0a6a474b-f2ca-46ea-9e72-deea9077d92f",
141
+ * "x-amz-server-side-encryption-context": "eyJzb21ldGhpbmciOiJ0aGVyZSJ9"
142
+ * }
143
+ * }
144
+ * *\/
145
+ * // example id: example-2
146
+ * ```
147
+ *
89
148
  */
90
149
  export declare class CreatePresignedUrlCommand extends CreatePresignedUrlCommand_base {
91
150
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/DescribeQAppPermissionsCommand.d.ts CHANGED
@@ -86,6 +86,40 @@ declare const DescribeQAppPermissionsCommand_base: {
86
86
  * <p>Base exception class for all service exceptions from QApps service.</p>
87
87
  *
88
88
  * @public
89
+ * @example Describe permissions for the app
90
+ * ```javascript
91
+ * //
92
+ * const input = {
93
+ * "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
94
+ * "instanceId": "01793661-ad73-4c7d-8eaa-1c95a10151c2"
95
+ * };
96
+ * const command = new DescribeQAppPermissionsCommand(input);
97
+ * const response = await client.send(command);
98
+ * /* response ==
99
+ * {
100
+ * "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
101
+ * "permissions": [
102
+ * {
103
+ * "action": "write",
104
+ * "principal": {
105
+ * "email": "user1@example.com",
106
+ * "userId": "f8f15330-b091-708b-d46e-adb0d914b699"
107
+ * }
108
+ * },
109
+ * {
110
+ * "action": "read",
111
+ * "principal": {
112
+ * "email": "user2@example.com",
113
+ * "userId": "c81133d0-10d1-70eb-aaa3-d427ea6fc0f3"
114
+ * }
115
+ * }
116
+ * ],
117
+ * "resourceArn": "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
118
+ * }
119
+ * *\/
120
+ * // example id: example-1
121
+ * ```
122
+ *
89
123
  */
90
124
  export declare class DescribeQAppPermissionsCommand extends DescribeQAppPermissionsCommand_base {
91
125
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/GetQAppSessionMetadataCommand.d.ts CHANGED
@@ -87,6 +87,31 @@ declare const GetQAppSessionMetadataCommand_base: {
87
87
  * <p>Base exception class for all service exceptions from QApps service.</p>
88
88
  *
89
89
  * @public
90
+ * @example Retrieves an existing session metadata for an Amazon Q App
91
+ * ```javascript
92
+ * //
93
+ * const input = {
94
+ * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
95
+ * "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb"
96
+ * };
97
+ * const command = new GetQAppSessionMetadataCommand(input);
98
+ * const response = await client.send(command);
99
+ * /* response ==
100
+ * {
101
+ * "sessionArn": "arn:aws:qapps:us-west-2:0123456789012:application/cbea8329-41c0-4566-a112-19250921a220/qapp/387ccac9-4717-489f-841f-729b7d7de355/session/56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
102
+ * "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
103
+ * "sessionName": "Trip itinerary collection session",
104
+ * "sessionOwner": true,
105
+ * "sharingConfiguration": {
106
+ * "acceptResponses": true,
107
+ * "enabled": true,
108
+ * "revealCards": false
109
+ * }
110
+ * }
111
+ * *\/
112
+ * // example id: example-1
113
+ * ```
114
+ *
90
115
  */
91
116
  export declare class GetQAppSessionMetadataCommand extends GetQAppSessionMetadataCommand_base {
92
117
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/UpdateQAppPermissionsCommand.d.ts CHANGED
@@ -98,6 +98,79 @@ declare const UpdateQAppPermissionsCommand_base: {
98
98
  * <p>Base exception class for all service exceptions from QApps service.</p>
99
99
  *
100
100
  * @public
101
+ * @example Grant permissions for the app
102
+ * ```javascript
103
+ * //
104
+ * const input = {
105
+ * "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
106
+ * "grantPermissions": [
107
+ * {
108
+ * "action": "read",
109
+ * "principal": "user2@example.com"
110
+ * }
111
+ * ],
112
+ * "instanceId": "01793661-ad73-4c7d-8eaa-1c95a10151c2"
113
+ * };
114
+ * const command = new UpdateQAppPermissionsCommand(input);
115
+ * const response = await client.send(command);
116
+ * /* response ==
117
+ * {
118
+ * "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
119
+ * "permissions": [
120
+ * {
121
+ * "action": "write",
122
+ * "principal": {
123
+ * "email": "user1@example.com",
124
+ * "userId": "f8f15330-b091-708b-d46e-adb0d914b699"
125
+ * }
126
+ * },
127
+ * {
128
+ * "action": "read",
129
+ * "principal": {
130
+ * "email": "user2@example.com",
131
+ * "userId": "c81133d0-10d1-70eb-aaa3-d427ea6fc0f3"
132
+ * }
133
+ * }
134
+ * ],
135
+ * "resourceArn": "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
136
+ * }
137
+ * *\/
138
+ * // example id: example-1
139
+ * ```
140
+ *
141
+ * @example Revoke permissions for the app
142
+ * ```javascript
143
+ * //
144
+ * const input = {
145
+ * "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
146
+ * "instanceId": "01793661-ad73-4c7d-8eaa-1c95a10151c2",
147
+ * "revokePermissions": [
148
+ * {
149
+ * "action": "read",
150
+ * "principal": "user2@example.com"
151
+ * }
152
+ * ]
153
+ * };
154
+ * const command = new UpdateQAppPermissionsCommand(input);
155
+ * const response = await client.send(command);
156
+ * /* response ==
157
+ * {
158
+ * "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
159
+ * "permissions": [
160
+ * {
161
+ * "action": "write",
162
+ * "principal": {
163
+ * "email": "user1@example.com",
164
+ * "userId": "f8f15330-b091-708b-d46e-adb0d914b699"
165
+ * }
166
+ * }
167
+ * ],
168
+ * "resourceArn": "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
169
+ * }
170
+ * *\/
171
+ * // example id: example-2
172
+ * ```
173
+ *
101
174
  */
102
175
  export declare class UpdateQAppPermissionsCommand extends UpdateQAppPermissionsCommand_base {
103
176
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/UpdateQAppSessionMetadataCommand.d.ts CHANGED
@@ -92,6 +92,36 @@ declare const UpdateQAppSessionMetadataCommand_base: {
92
92
  * <p>Base exception class for all service exceptions from QApps service.</p>
93
93
  *
94
94
  * @public
95
+ * @example Updates an existing session metadata for an Amazon Q App
96
+ * ```javascript
97
+ * //
98
+ * const input = {
99
+ * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
100
+ * "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
101
+ * "sessionName": "Trip itinerary collection session",
102
+ * "sharingConfiguration": {
103
+ * "acceptResponses": true,
104
+ * "enabled": true,
105
+ * "revealCards": false
106
+ * }
107
+ * };
108
+ * const command = new UpdateQAppSessionMetadataCommand(input);
109
+ * const response = await client.send(command);
110
+ * /* response ==
111
+ * {
112
+ * "sessionArn": "arn:aws:qapps:us-west-2:0123456789012:application/cbea8329-41c0-4566-a112-19250921a220/qapp/387ccac9-4717-489f-841f-729b7d7de355/session/56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
113
+ * "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
114
+ * "sessionName": "Trip itinerary collection session",
115
+ * "sharingConfiguration": {
116
+ * "acceptResponses": true,
117
+ * "enabled": true,
118
+ * "revealCards": false
119
+ * }
120
+ * }
121
+ * *\/
122
+ * // example id: example-1
123
+ * ```
124
+ *
95
125
  */
96
126
  export declare class UpdateQAppSessionMetadataCommand extends UpdateQAppSessionMetadataCommand_base {
97
127
  /** @internal type navigation helper, not in runtime. */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-qapps",
3
3
  "description": "AWS SDK for JavaScript Qapps Client for Node.js, Browser and React Native",
4
- "version": "3.701.0",
4
+ "version": "3.702.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",