@aws-sdk/client-artifact 3.775.0 → 3.777.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.
@@ -75,23 +75,23 @@ declare const GetAccountSettingsCommand_base: {
75
75
  * @throws {@link ArtifactServiceException}
76
76
  * <p>Base exception class for all service exceptions from Artifact service.</p>
77
77
  *
78
- * @public
78
+ *
79
79
  * @example Invoke GetAccountSettings operation
80
80
  * ```javascript
81
81
  * // Get the current account settings.
82
- * const input = {};
82
+ * const input = { /* empty *\/ };
83
83
  * const command = new GetAccountSettingsCommand(input);
84
84
  * const response = await client.send(command);
85
- * /* response ==
85
+ * /* response is
86
86
  * {
87
- * "accountSettings": {
88
- * "notificationSubscriptionStatus": "SUBSCRIBED"
87
+ * accountSettings: {
88
+ * notificationSubscriptionStatus: "SUBSCRIBED"
89
89
  * }
90
90
  * }
91
91
  * *\/
92
- * // example id: example-1
93
92
  * ```
94
93
  *
94
+ * @public
95
95
  */
96
96
  export declare class GetAccountSettingsCommand extends GetAccountSettingsCommand_base {
97
97
  /** @internal type navigation helper, not in runtime. */
@@ -77,27 +77,27 @@ declare const GetReportCommand_base: {
77
77
  * @throws {@link ArtifactServiceException}
78
78
  * <p>Base exception class for all service exceptions from Artifact service.</p>
79
79
  *
80
- * @public
80
+ *
81
81
  * @example Invoke GetReport operation on the latest version of a specific report
82
82
  * ```javascript
83
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
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
87
  * const input = {
88
- * "reportId": "report-abcdef0123456789",
89
- * "termToken": "term-token-abcdefghijklm01234567890"
88
+ * reportId: "report-abcdef0123456789",
89
+ * termToken: "term-token-abcdefghijklm01234567890"
90
90
  * };
91
91
  * const command = new GetReportCommand(input);
92
92
  * const response = await client.send(command);
93
- * /* response ==
93
+ * /* response is
94
94
  * {
95
- * "documentPresignedUrl": "<Presigned S3 URL>"
95
+ * documentPresignedUrl: "<Presigned S3 URL>"
96
96
  * }
97
97
  * *\/
98
- * // example id: example-1
99
98
  * ```
100
99
  *
100
+ * @public
101
101
  */
102
102
  export declare class GetReportCommand extends GetReportCommand_base {
103
103
  /** @internal type navigation helper, not in runtime. */
@@ -94,39 +94,39 @@ declare const GetReportMetadataCommand_base: {
94
94
  * @throws {@link ArtifactServiceException}
95
95
  * <p>Base exception class for all service exceptions from Artifact service.</p>
96
96
  *
97
- * @public
97
+ *
98
98
  * @example Invoke GetReportMetadata operation on the latest version of a specific report
99
99
  * ```javascript
100
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.
101
+ * If callers do not provide a version, it will default to the report's latest version.
102
102
  * const input = {
103
- * "reportId": "report-bqhUJF3FrQZsMJpb"
103
+ * reportId: "report-bqhUJF3FrQZsMJpb"
104
104
  * };
105
105
  * const command = new GetReportMetadataCommand(input);
106
106
  * const response = await client.send(command);
107
- * /* response ==
107
+ * /* response is
108
108
  * {
109
- * "reportDetails": {
110
- * "version": 1,
111
- * "name": "Name of report",
112
- * "arn": "arn:aws:artifact:us-east-1::report/report-abcdef0123456789:1",
113
- * "category": "Artifact Category",
114
- * "companyName": "AWS",
115
- * "createdAt": "2022-05-27T23:17:00.343940Z",
116
- * "description": "Description of report",
117
- * "id": "report-abcdef0123456789",
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-abcdef0123456789:1"
109
+ * reportDetails: {
110
+ * arn: "arn:aws:artifact:us-east-1::report/report-abcdef0123456789:1",
111
+ * category: "Artifact Category",
112
+ * companyName: "AWS",
113
+ * createdAt: "2022-05-27T23:17:00.343940Z",
114
+ * description: "Description of report",
115
+ * id: "report-abcdef0123456789",
116
+ * name: "Name of report",
117
+ * periodEnd: "2022-04-01T20:32:04Z",
118
+ * periodStart: "2022-04-01T20:32:04Z",
119
+ * productName: "Product of report",
120
+ * series: "Artifact Series",
121
+ * state: "PUBLISHED",
122
+ * termArn: "arn:aws:artifact:us-east-1::term/term-abcdef0123456789:1",
123
+ * version: 1
124
124
  * }
125
125
  * }
126
126
  * *\/
127
- * // example id: example-1
128
127
  * ```
129
128
  *
129
+ * @public
130
130
  */
131
131
  export declare class GetReportMetadataCommand extends GetReportMetadataCommand_base {
132
132
  /** @internal type navigation helper, not in runtime. */
@@ -77,25 +77,25 @@ declare const GetTermForReportCommand_base: {
77
77
  * @throws {@link ArtifactServiceException}
78
78
  * <p>Base exception class for all service exceptions from Artifact service.</p>
79
79
  *
80
- * @public
80
+ *
81
81
  * @example Invoke GetTermForReport operation on the latest version of a specific report
82
82
  * ```javascript
83
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.
84
+ * If callers do not provide a version, it will default to the report's latest version.
85
85
  * const input = {
86
- * "reportId": "report-abcdef0123456789"
86
+ * reportId: "report-abcdef0123456789"
87
87
  * };
88
88
  * const command = new GetTermForReportCommand(input);
89
89
  * const response = await client.send(command);
90
- * /* response ==
90
+ * /* response is
91
91
  * {
92
- * "documentPresignedUrl": "<Presigned S3 URL>",
93
- * "termToken": "term-token-abcdefghijklm01234567890"
92
+ * documentPresignedUrl: "<Presigned S3 URL>",
93
+ * termToken: "term-token-abcdefghijklm01234567890"
94
94
  * }
95
95
  * *\/
96
- * // example id: example-1
97
96
  * ```
98
97
  *
98
+ * @public
99
99
  */
100
100
  export declare class GetTermForReportCommand extends GetTermForReportCommand_base {
101
101
  /** @internal type navigation helper, not in runtime. */
@@ -88,40 +88,40 @@ declare const ListCustomerAgreementsCommand_base: {
88
88
  * @throws {@link ArtifactServiceException}
89
89
  * <p>Base exception class for all service exceptions from Artifact service.</p>
90
90
  *
91
- * @public
91
+ *
92
92
  * @example Invoke ListCustomerAgreements operation
93
93
  * ```javascript
94
94
  * // The ListCustomerAgreements operation returns a collection of customer-agreement resources in the ACTIVE state for the calling credential.
95
- * const input = {};
95
+ * const input = { /* empty *\/ };
96
96
  * const command = new ListCustomerAgreementsCommand(input);
97
97
  * const response = await client.send(command);
98
- * /* response ==
98
+ * /* response is
99
99
  * {
100
- * "customerAgreements": [
100
+ * customerAgreements: [
101
101
  * {
102
- * "name": "Name of agreement",
103
- * "type": "DEFAULT",
104
- * "acceptanceTerms": [
102
+ * acceptanceTerms: [
105
103
  * "terms acknowledged when agreement was accepted"
106
104
  * ],
107
- * "agreementArn": "arn:aws:artifact:::agreement/agreement-abcdef0123456789",
108
- * "arn": "arn:aws:artifact::111111111111:customer-agreement/customer-agreement-abcdef0123456789",
109
- * "awsAccountId": "111111111111",
110
- * "description": "Description of agreement",
111
- * "effectiveStart": "2022-04-01T20:32:04Z",
112
- * "id": "customer-agreement-abcdef0123456789",
113
- * "state": "ACTIVE",
114
- * "terminateTerms": [
105
+ * agreementArn: "arn:aws:artifact:::agreement/agreement-abcdef0123456789",
106
+ * arn: "arn:aws:artifact::111111111111:customer-agreement/customer-agreement-abcdef0123456789",
107
+ * awsAccountId: "111111111111",
108
+ * description: "Description of agreement",
109
+ * effectiveStart: "2022-04-01T20:32:04Z",
110
+ * id: "customer-agreement-abcdef0123456789",
111
+ * name: "Name of agreement",
112
+ * state: "ACTIVE",
113
+ * terminateTerms: [
115
114
  * "terms that must be acknowledged to terminate this agreement"
116
- * ]
115
+ * ],
116
+ * type: "DEFAULT"
117
117
  * }
118
118
  * ],
119
- * "nextToken": "gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7"
119
+ * nextToken: "gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7"
120
120
  * }
121
121
  * *\/
122
- * // example id: example-1
123
122
  * ```
124
123
  *
124
+ * @public
125
125
  */
126
126
  export declare class ListCustomerAgreementsCommand extends ListCustomerAgreementsCommand_base {
127
127
  /** @internal type navigation helper, not in runtime. */
@@ -92,37 +92,37 @@ declare const ListReportsCommand_base: {
92
92
  * @throws {@link ArtifactServiceException}
93
93
  * <p>Base exception class for all service exceptions from Artifact service.</p>
94
94
  *
95
- * @public
95
+ *
96
96
  * @example Invoke ListReports operation
97
97
  * ```javascript
98
98
  * // The ListReports operation returns a collection of report resources.
99
- * const input = {};
99
+ * const input = { /* empty *\/ };
100
100
  * const command = new ListReportsCommand(input);
101
101
  * const response = await client.send(command);
102
- * /* response ==
102
+ * /* response is
103
103
  * {
104
- * "nextToken": "gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7",
105
- * "reports": [
104
+ * nextToken: "gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7",
105
+ * reports: [
106
106
  * {
107
- * "version": 1,
108
- * "name": "Name of report",
109
- * "arn": "arn:aws:artifact:us-east-1::report/report-abcdef0123456789",
110
- * "category": "Artifact Category",
111
- * "companyName": "AWS",
112
- * "description": "Description of report",
113
- * "id": "report-abcdef0123456789",
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"
107
+ * arn: "arn:aws:artifact:us-east-1::report/report-abcdef0123456789",
108
+ * category: "Artifact Category",
109
+ * companyName: "AWS",
110
+ * description: "Description of report",
111
+ * id: "report-abcdef0123456789",
112
+ * name: "Name of report",
113
+ * periodEnd: "2022-04-01T20:32:04Z",
114
+ * periodStart: "2022-04-01T20:32:04Z",
115
+ * productName: "Product of report",
116
+ * series: "Artifact Series",
117
+ * state: "PUBLISHED",
118
+ * version: 1
119
119
  * }
120
120
  * ]
121
121
  * }
122
122
  * *\/
123
- * // example id: example-1
124
123
  * ```
125
124
  *
125
+ * @public
126
126
  */
127
127
  export declare class ListReportsCommand extends ListReportsCommand_base {
128
128
  /** @internal type navigation helper, not in runtime. */
@@ -77,25 +77,25 @@ declare const PutAccountSettingsCommand_base: {
77
77
  * @throws {@link ArtifactServiceException}
78
78
  * <p>Base exception class for all service exceptions from Artifact service.</p>
79
79
  *
80
- * @public
80
+ *
81
81
  * @example Invoke PutAccountSettings operation
82
82
  * ```javascript
83
83
  * // Set the account settings.
84
84
  * const input = {
85
- * "notificationSubscriptionStatus": "SUBSCRIBED"
85
+ * notificationSubscriptionStatus: "SUBSCRIBED"
86
86
  * };
87
87
  * const command = new PutAccountSettingsCommand(input);
88
88
  * const response = await client.send(command);
89
- * /* response ==
89
+ * /* response is
90
90
  * {
91
- * "accountSettings": {
92
- * "notificationSubscriptionStatus": "SUBSCRIBED"
91
+ * accountSettings: {
92
+ * notificationSubscriptionStatus: "SUBSCRIBED"
93
93
  * }
94
94
  * }
95
95
  * *\/
96
- * // example id: example-1
97
96
  * ```
98
97
  *
98
+ * @public
99
99
  */
100
100
  export declare class PutAccountSettingsCommand extends PutAccountSettingsCommand_base {
101
101
  /** @internal type navigation helper, not in runtime. */
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.775.0",
4
+ "version": "3.777.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",
@@ -21,7 +21,7 @@
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
23
  "@aws-sdk/core": "3.775.0",
24
- "@aws-sdk/credential-provider-node": "3.775.0",
24
+ "@aws-sdk/credential-provider-node": "3.777.0",
25
25
  "@aws-sdk/middleware-host-header": "3.775.0",
26
26
  "@aws-sdk/middleware-logger": "3.775.0",
27
27
  "@aws-sdk/middleware-recursion-detection": "3.775.0",