@aws-sdk/client-artifact 3.601.0 → 3.606.0

package/dist-types/commands/GetAccountSettingsCommand.d.ts

@@ -76,6 +76,22 @@ declare const GetAccountSettingsCommand_base: {
  * <p>Base exception class for all service exceptions from Artifact service.</p>
  *
  * @public
+ * @example Invoke GetAccountSettings operation
+ * ```javascript
+ * // Get the current account settings.
+ * const input = {};
+ * const command = new GetAccountSettingsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "accountSettings": {
+ *     "notificationSubscriptionStatus": "SUBSCRIBED"
+ *   }
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class GetAccountSettingsCommand extends GetAccountSettingsCommand_base {
 }

package/dist-types/commands/GetReportCommand.d.ts

@@ -78,6 +78,26 @@ declare const GetReportCommand_base: {
  * <p>Base exception class for all service exceptions from Artifact service.</p>
  *
  * @public
+ * @example Invoke GetReport operation on the latest version of a specific report
+ * ```javascript
+ * // The GetReport operation is invoked on a reportId and on a optional version.
+ * //                         Callers must provide a termToken, which is provided by the GetTermForReport
+ * //                         operation. If callers do not provide a version, it will default to the
+ * //                         report's latest version
+ * const input = {
+ *   "reportId": "report-1hVFddebtfDNJAUf",
+ *   "termToken": "term-token-gPFEGk7CF4wS901w7ppYclt7"
+ * };
+ * const command = new GetReportCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "documentPresignedUrl": "<Presigned S3 URL>"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class GetReportCommand extends GetReportCommand_base {
 }

package/dist-types/commands/GetReportMetadataCommand.d.ts

@@ -95,6 +95,38 @@ declare const GetReportMetadataCommand_base: {
  * <p>Base exception class for all service exceptions from Artifact service.</p>
  *
  * @public
+ * @example Invoke GetReportMetadata operation on the latest version of a specific report
+ * ```javascript
+ * // The GetReportMetadata operation is invoked on a reportId and on a optional version.
+ * //                         If callers do not provide a version, it will default to the report's latest version.
+ * const input = {
+ *   "reportId": "report-bqhUJF3FrQZsMJpb"
+ * };
+ * const command = new GetReportMetadataCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "reportDetails": {
+ *     "version": 1,
+ *     "name": "Name of report",
+ *     "arn": "arn:aws:artifact:us-east-1::report/report-bqhUJF3FrQZsMJpb:1",
+ *     "category": "Artifact Category",
+ *     "companyName": "AWS",
+ *     "createdAt": "2022-05-27T23:17:00.343940Z",
+ *     "description": "Description of report",
+ *     "id": "report-bqhUJF3FrQZsMJpb",
+ *     "periodEnd": "2022-04-01T20:32:04Z",
+ *     "periodStart": "2022-04-01T20:32:04Z",
+ *     "productName": "Product of report",
+ *     "series": "Artifact Series",
+ *     "state": "PUBLISHED",
+ *     "termArn": "arn:aws:artifact:us-east-1::term/term-gLJGG12NyPtYcmtu:1"
+ *   }
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class GetReportMetadataCommand extends GetReportMetadataCommand_base {
 }

package/dist-types/commands/GetTermForReportCommand.d.ts

@@ -78,6 +78,24 @@ declare const GetTermForReportCommand_base: {
  * <p>Base exception class for all service exceptions from Artifact service.</p>
  *
  * @public
+ * @example Invoke GetTermForReport operation on the latest version of a specific report
+ * ```javascript
+ * // The GetTermForReport operation is invoked on a reportId and on a optional version.
+ * //                         If callers do not provide a version, it will default to the report's latest version.
+ * const input = {
+ *   "reportId": "report-bqhUJF3FrQZsMJpb"
+ * };
+ * const command = new GetTermForReportCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "documentPresignedUrl": "<Presigned S3 URL>",
+ *   "termToken": "term-token-gPFEGk7CF4wS901w7ppYclt7"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class GetTermForReportCommand extends GetTermForReportCommand_base {
 }

package/dist-types/commands/ListReportsCommand.d.ts

@@ -93,6 +93,36 @@ declare const ListReportsCommand_base: {
  * <p>Base exception class for all service exceptions from Artifact service.</p>
  *
  * @public
+ * @example Invoke ListReports operation
+ * ```javascript
+ * // The ListReports operation returns a collection of report resources.
+ * const input = {};
+ * const command = new ListReportsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "nextToken": "gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7",
+ *   "reports": [
+ *     {
+ *       "version": 1,
+ *       "name": "Name of report",
+ *       "arn": "arn:aws:artifact:us-east-1::report/report-bqhUJF3FrQZsMJpb",
+ *       "category": "Artifact Category",
+ *       "companyName": "AWS",
+ *       "description": "Description of report",
+ *       "id": "report-bqhUJF3FrQZsMJpb",
+ *       "periodEnd": "2022-04-01T20:32:04Z",
+ *       "periodStart": "2022-04-01T20:32:04Z",
+ *       "productName": "Product of report",
+ *       "series": "Artifact Series",
+ *       "state": "PUBLISHED"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class ListReportsCommand extends ListReportsCommand_base {
 }

package/dist-types/commands/PutAccountSettingsCommand.d.ts

@@ -78,6 +78,24 @@ declare const PutAccountSettingsCommand_base: {
  * <p>Base exception class for all service exceptions from Artifact service.</p>
  *
  * @public
+ * @example Invoke PutAccountSettings operation
+ * ```javascript
+ * // Set the account settings.
+ * const input = {
+ *   "notificationSubscriptionStatus": "SUBSCRIBED"
+ * };
+ * const command = new PutAccountSettingsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "accountSettings": {
+ *     "notificationSubscriptionStatus": "SUBSCRIBED"
+ *   }
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class PutAccountSettingsCommand extends PutAccountSettingsCommand_base {
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-artifact",
   "description": "AWS SDK for JavaScript Artifact Client for Node.js, Browser and React Native",
-  "version": "3.601.0",
+  "version": "3.606.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,8 +20,8 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/client-sso-oidc": "3.600.0",
-    "@aws-sdk/client-sts": "3.600.0",
+    "@aws-sdk/client-sso-oidc": "3.606.0",
+    "@aws-sdk/client-sts": "3.606.0",
     "@aws-sdk/core": "3.598.0",
     "@aws-sdk/credential-provider-node": "3.600.0",
     "@aws-sdk/middleware-host-header": "3.598.0",