@aws-sdk/client-artifact 3.600.0 → 3.602.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.
@@ -356,6 +356,7 @@ const de_ReportsList = (output, context) => {
356
356
  };
357
357
  const de_ReportSummary = (output, context) => {
358
358
  return (0, smithy_client_1.take)(output, {
359
+ acceptanceType: smithy_client_1.expectString,
359
360
  arn: smithy_client_1.expectString,
360
361
  category: smithy_client_1.expectString,
361
362
  companyName: smithy_client_1.expectString,
@@ -341,6 +341,7 @@ const de_ReportsList = (output, context) => {
341
341
  };
342
342
  const de_ReportSummary = (output, context) => {
343
343
  return take(output, {
344
+ acceptanceType: __expectString,
344
345
  arn: __expectString,
345
346
  category: __expectString,
346
347
  companyName: __expectString,
@@ -76,6 +76,22 @@ declare const GetAccountSettingsCommand_base: {
76
76
  * <p>Base exception class for all service exceptions from Artifact service.</p>
77
77
  *
78
78
  * @public
79
+ * @example Invoke GetAccountSettings operation
80
+ * ```javascript
81
+ * // Get the current account settings.
82
+ * const input = {};
83
+ * const command = new GetAccountSettingsCommand(input);
84
+ * const response = await client.send(command);
85
+ * /* response ==
86
+ * {
87
+ * "accountSettings": {
88
+ * "notificationSubscriptionStatus": "SUBSCRIBED"
89
+ * }
90
+ * }
91
+ * *\/
92
+ * // example id: example-1
93
+ * ```
94
+ *
79
95
  */
80
96
  export declare class GetAccountSettingsCommand extends GetAccountSettingsCommand_base {
81
97
  }
@@ -78,6 +78,26 @@ declare const GetReportCommand_base: {
78
78
  * <p>Base exception class for all service exceptions from Artifact service.</p>
79
79
  *
80
80
  * @public
81
+ * @example Invoke GetReport operation on the latest version of a specific report
82
+ * ```javascript
83
+ * // The GetReport operation is invoked on a reportId and on a optional version.
84
+ * // Callers must provide a termToken, which is provided by the GetTermForReport
85
+ * // operation. If callers do not provide a version, it will default to the
86
+ * // report's latest version
87
+ * const input = {
88
+ * "reportId": "report-1hVFddebtfDNJAUf",
89
+ * "termToken": "term-token-gPFEGk7CF4wS901w7ppYclt7"
90
+ * };
91
+ * const command = new GetReportCommand(input);
92
+ * const response = await client.send(command);
93
+ * /* response ==
94
+ * {
95
+ * "documentPresignedUrl": "<Presigned S3 URL>"
96
+ * }
97
+ * *\/
98
+ * // example id: example-1
99
+ * ```
100
+ *
81
101
  */
82
102
  export declare class GetReportCommand extends GetReportCommand_base {
83
103
  }
@@ -95,6 +95,38 @@ declare const GetReportMetadataCommand_base: {
95
95
  * <p>Base exception class for all service exceptions from Artifact service.</p>
96
96
  *
97
97
  * @public
98
+ * @example Invoke GetReportMetadata operation on the latest version of a specific report
99
+ * ```javascript
100
+ * // The GetReportMetadata operation is invoked on a reportId and on a optional version.
101
+ * // If callers do not provide a version, it will default to the report's latest version.
102
+ * const input = {
103
+ * "reportId": "report-bqhUJF3FrQZsMJpb"
104
+ * };
105
+ * const command = new GetReportMetadataCommand(input);
106
+ * const response = await client.send(command);
107
+ * /* response ==
108
+ * {
109
+ * "reportDetails": {
110
+ * "version": 1,
111
+ * "name": "Name of report",
112
+ * "arn": "arn:aws:artifact:us-east-1::report/report-bqhUJF3FrQZsMJpb:1",
113
+ * "category": "Artifact Category",
114
+ * "companyName": "AWS",
115
+ * "createdAt": "2022-05-27T23:17:00.343940Z",
116
+ * "description": "Description of report",
117
+ * "id": "report-bqhUJF3FrQZsMJpb",
118
+ * "periodEnd": "2022-04-01T20:32:04Z",
119
+ * "periodStart": "2022-04-01T20:32:04Z",
120
+ * "productName": "Product of report",
121
+ * "series": "Artifact Series",
122
+ * "state": "PUBLISHED",
123
+ * "termArn": "arn:aws:artifact:us-east-1::term/term-gLJGG12NyPtYcmtu:1"
124
+ * }
125
+ * }
126
+ * *\/
127
+ * // example id: example-1
128
+ * ```
129
+ *
98
130
  */
99
131
  export declare class GetReportMetadataCommand extends GetReportMetadataCommand_base {
100
132
  }
@@ -78,6 +78,24 @@ declare const GetTermForReportCommand_base: {
78
78
  * <p>Base exception class for all service exceptions from Artifact service.</p>
79
79
  *
80
80
  * @public
81
+ * @example Invoke GetTermForReport operation on the latest version of a specific report
82
+ * ```javascript
83
+ * // The GetTermForReport operation is invoked on a reportId and on a optional version.
84
+ * // If callers do not provide a version, it will default to the report's latest version.
85
+ * const input = {
86
+ * "reportId": "report-bqhUJF3FrQZsMJpb"
87
+ * };
88
+ * const command = new GetTermForReportCommand(input);
89
+ * const response = await client.send(command);
90
+ * /* response ==
91
+ * {
92
+ * "documentPresignedUrl": "<Presigned S3 URL>",
93
+ * "termToken": "term-token-gPFEGk7CF4wS901w7ppYclt7"
94
+ * }
95
+ * *\/
96
+ * // example id: example-1
97
+ * ```
98
+ *
81
99
  */
82
100
  export declare class GetTermForReportCommand extends GetTermForReportCommand_base {
83
101
  }
@@ -57,6 +57,7 @@ declare const ListReportsCommand_base: {
57
57
  * // companyName: "STRING_VALUE",
58
58
  * // productName: "STRING_VALUE",
59
59
  * // statusMessage: "STRING_VALUE",
60
+ * // acceptanceType: "STRING_VALUE",
60
61
  * // },
61
62
  * // ],
62
63
  * // nextToken: "STRING_VALUE",
@@ -92,6 +93,36 @@ declare const ListReportsCommand_base: {
92
93
  * <p>Base exception class for all service exceptions from Artifact service.</p>
93
94
  *
94
95
  * @public
96
+ * @example Invoke ListReports operation
97
+ * ```javascript
98
+ * // The ListReports operation returns a collection of report resources.
99
+ * const input = {};
100
+ * const command = new ListReportsCommand(input);
101
+ * const response = await client.send(command);
102
+ * /* response ==
103
+ * {
104
+ * "nextToken": "gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7",
105
+ * "reports": [
106
+ * {
107
+ * "version": 1,
108
+ * "name": "Name of report",
109
+ * "arn": "arn:aws:artifact:us-east-1::report/report-bqhUJF3FrQZsMJpb",
110
+ * "category": "Artifact Category",
111
+ * "companyName": "AWS",
112
+ * "description": "Description of report",
113
+ * "id": "report-bqhUJF3FrQZsMJpb",
114
+ * "periodEnd": "2022-04-01T20:32:04Z",
115
+ * "periodStart": "2022-04-01T20:32:04Z",
116
+ * "productName": "Product of report",
117
+ * "series": "Artifact Series",
118
+ * "state": "PUBLISHED"
119
+ * }
120
+ * ]
121
+ * }
122
+ * *\/
123
+ * // example id: example-1
124
+ * ```
125
+ *
95
126
  */
96
127
  export declare class ListReportsCommand extends ListReportsCommand_base {
97
128
  }
@@ -78,6 +78,24 @@ declare const PutAccountSettingsCommand_base: {
78
78
  * <p>Base exception class for all service exceptions from Artifact service.</p>
79
79
  *
80
80
  * @public
81
+ * @example Invoke PutAccountSettings operation
82
+ * ```javascript
83
+ * // Set the account settings.
84
+ * const input = {
85
+ * "notificationSubscriptionStatus": "SUBSCRIBED"
86
+ * };
87
+ * const command = new PutAccountSettingsCommand(input);
88
+ * const response = await client.send(command);
89
+ * /* response ==
90
+ * {
91
+ * "accountSettings": {
92
+ * "notificationSubscriptionStatus": "SUBSCRIBED"
93
+ * }
94
+ * }
95
+ * *\/
96
+ * // example id: example-1
97
+ * ```
98
+ *
81
99
  */
82
100
  export declare class PutAccountSettingsCommand extends PutAccountSettingsCommand_base {
83
101
  }
@@ -587,6 +587,11 @@ export interface ReportSummary {
587
587
  * @public
588
588
  */
589
589
  statusMessage?: string;
590
+ /**
591
+ * <p>Acceptance type for report.</p>
592
+ * @public
593
+ */
594
+ acceptanceType?: AcceptanceType;
590
595
  }
591
596
  /**
592
597
  * @public
@@ -180,6 +180,7 @@ export interface ReportSummary {
180
180
  companyName?: string;
181
181
  productName?: string;
182
182
  statusMessage?: string;
183
+ acceptanceType?: AcceptanceType;
183
184
  }
184
185
  export interface ListReportsResponse {
185
186
  reports?: ReportSummary[];
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-artifact",
3
3
  "description": "AWS SDK for JavaScript Artifact Client for Node.js, Browser and React Native",
4
- "version": "3.600.0",
4
+ "version": "3.602.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",