@aws-sdk/client-artifact 3.515.0

package/dist-types/models/models_0.d.ts

@@ -0,0 +1,605 @@
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { ArtifactServiceException as __BaseException } from "./ArtifactServiceException";
+/**
+ * @public
+ * @enum
+ */
+export declare const AcceptanceType: {
+    /**
+     * Require explicit click-through acceptance of
+     * the Term associated with this Report.
+     */
+    readonly EXPLICIT: "EXPLICIT";
+    /**
+     * Do not require explicit click-through
+     * acceptance of the Term associated with
+     * this Report.
+     */
+    readonly PASSTHROUGH: "PASSTHROUGH";
+};
+/**
+ * @public
+ */
+export type AcceptanceType = (typeof AcceptanceType)[keyof typeof AcceptanceType];
+/**
+ * @public
+ * <p>User does not have sufficient access to perform this action.</p>
+ */
+export declare class AccessDeniedException extends __BaseException {
+    readonly name: "AccessDeniedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const NotificationSubscriptionStatus: {
+    /**
+     * The account is not subscribed for notification.
+     */
+    readonly NOT_SUBSCRIBED: "NOT_SUBSCRIBED";
+    /**
+     * The account is subscribed for notification.
+     */
+    readonly SUBSCRIBED: "SUBSCRIBED";
+};
+/**
+ * @public
+ */
+export type NotificationSubscriptionStatus = (typeof NotificationSubscriptionStatus)[keyof typeof NotificationSubscriptionStatus];
+/**
+ * @public
+ * <p>Account settings for the customer.</p>
+ */
+export interface AccountSettings {
+    /**
+     * @public
+     * <p>Notification subscription status of the customer.</p>
+     */
+    notificationSubscriptionStatus?: NotificationSubscriptionStatus;
+}
+/**
+ * @public
+ * <p>Request to create/modify content would result in a conflict.</p>
+ */
+export declare class ConflictException extends __BaseException {
+    readonly name: "ConflictException";
+    readonly $fault: "client";
+    /**
+     * @public
+     * <p>Identifier of the affected resource.</p>
+     */
+    resourceId: string | undefined;
+    /**
+     * @public
+     * <p>Type of the affected resource.</p>
+     */
+    resourceType: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface GetAccountSettingsRequest {
+}
+/**
+ * @public
+ */
+export interface GetAccountSettingsResponse {
+    /**
+     * @public
+     * <p>Account settings for the customer.</p>
+     */
+    accountSettings?: AccountSettings;
+}
+/**
+ * @public
+ * <p>An unknown server exception has occurred.</p>
+ */
+export declare class InternalServerException extends __BaseException {
+    readonly name: "InternalServerException";
+    readonly $fault: "server";
+    $retryable: {};
+    /**
+     * @public
+     * <p>Number of seconds in which the caller can retry the request.</p>
+     */
+    retryAfterSeconds?: number;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
+}
+/**
+ * @public
+ * <p>Request references a resource which does not exist.</p>
+ */
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @public
+     * <p>Identifier of the affected resource.</p>
+     */
+    resourceId: string | undefined;
+    /**
+     * @public
+     * <p>Type of the affected resource.</p>
+     */
+    resourceType: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ * <p>Request would cause a service quota to be exceeded.</p>
+ */
+export declare class ServiceQuotaExceededException extends __BaseException {
+    readonly name: "ServiceQuotaExceededException";
+    readonly $fault: "client";
+    /**
+     * @public
+     * <p>Identifier of the affected resource.</p>
+     */
+    resourceId: string | undefined;
+    /**
+     * @public
+     * <p>Type of the affected resource.</p>
+     */
+    resourceType: string | undefined;
+    /**
+     * @public
+     * <p>Code for the affected service.</p>
+     */
+    serviceCode: string | undefined;
+    /**
+     * @public
+     * <p>Code for the affected quota.</p>
+     */
+    quotaCode: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
+}
+/**
+ * @public
+ * <p>Request was denied due to request throttling.</p>
+ */
+export declare class ThrottlingException extends __BaseException {
+    readonly name: "ThrottlingException";
+    readonly $fault: "client";
+    $retryable: {
+        throttling: boolean;
+    };
+    /**
+     * @public
+     * <p>Code for the affected service.</p>
+     */
+    serviceCode?: string;
+    /**
+     * @public
+     * <p>Code for the affected quota.</p>
+     */
+    quotaCode?: string;
+    /**
+     * @public
+     * <p>Number of seconds in which the caller can retry the request.</p>
+     */
+    retryAfterSeconds?: number;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
+}
+/**
+ * @public
+ * <p>Validation exception message and name.</p>
+ */
+export interface ValidationExceptionField {
+    /**
+     * @public
+     * <p>Name of validation exception.</p>
+     */
+    name: string | undefined;
+    /**
+     * @public
+     * <p>Message describing why the field failed validation.</p>
+     */
+    message: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ValidationExceptionReason: {
+    readonly CANNOT_PARSE: "cannotParse";
+    readonly FIELD_VALIDATION_FAILED: "fieldValidationFailed";
+    readonly INVALID_TOKEN: "invalidToken";
+    readonly OTHER: "other";
+    readonly UNKNOWN_OPERATION: "unknownOperation";
+};
+/**
+ * @public
+ */
+export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
+/**
+ * @public
+ * <p>Request fails to satisfy the constraints specified by an AWS service.</p>
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    /**
+     * @public
+     * <p>Reason the request failed validation.</p>
+     */
+    reason: ValidationExceptionReason | undefined;
+    /**
+     * @public
+     * <p>The field that caused the error, if applicable.</p>
+     */
+    fieldList?: ValidationExceptionField[];
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface PutAccountSettingsRequest {
+    /**
+     * @public
+     * <p>Desired notification subscription status.</p>
+     */
+    notificationSubscriptionStatus?: NotificationSubscriptionStatus;
+}
+/**
+ * @public
+ */
+export interface PutAccountSettingsResponse {
+    /**
+     * @public
+     * <p>Account settings for the customer.</p>
+     */
+    accountSettings?: AccountSettings;
+}
+/**
+ * @public
+ */
+export interface GetReportRequest {
+    /**
+     * @public
+     * <p>Unique resource ID for the report resource.</p>
+     */
+    reportId: string | undefined;
+    /**
+     * @public
+     * <p>Version for the report resource.</p>
+     */
+    reportVersion?: number;
+    /**
+     * @public
+     * <p>Unique download token provided by GetTermForReport API.</p>
+     */
+    termToken: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetReportResponse {
+    /**
+     * @public
+     * <p>Presigned S3 url to access the report content.</p>
+     */
+    documentPresignedUrl?: string;
+}
+/**
+ * @public
+ */
+export interface GetReportMetadataRequest {
+    /**
+     * @public
+     * <p>Unique resource ID for the report resource.</p>
+     */
+    reportId: string | undefined;
+    /**
+     * @public
+     * <p>Version for the report resource.</p>
+     */
+    reportVersion?: number;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const PublishedState: {
+    /**
+     * The resource is published for consumption.
+     */
+    readonly PUBLISHED: "PUBLISHED";
+    /**
+     * The resource is not published for consumption.
+     */
+    readonly UNPUBLISHED: "UNPUBLISHED";
+};
+/**
+ * @public
+ */
+export type PublishedState = (typeof PublishedState)[keyof typeof PublishedState];
+/**
+ * @public
+ * @enum
+ */
+export declare const UploadState: {
+    readonly COMPLETE: "COMPLETE";
+    readonly FAILED: "FAILED";
+    readonly FAULT: "FAULT";
+    readonly PROCESSING: "PROCESSING";
+};
+/**
+ * @public
+ */
+export type UploadState = (typeof UploadState)[keyof typeof UploadState];
+/**
+ * @public
+ * <p>Full detail for report resource metadata.</p>
+ */
+export interface ReportDetail {
+    /**
+     * @public
+     * <p>Unique resource ID for the report resource.</p>
+     */
+    id?: string;
+    /**
+     * @public
+     * <p>Name for the report resource.</p>
+     */
+    name?: string;
+    /**
+     * @public
+     * <p>Description for the report resource.</p>
+     */
+    description?: string;
+    /**
+     * @public
+     * <p>Timestamp indicating the report resource effective start.</p>
+     */
+    periodStart?: Date;
+    /**
+     * @public
+     * <p>Timestamp indicating the report resource effective end.</p>
+     */
+    periodEnd?: Date;
+    /**
+     * @public
+     * <p>Timestamp indicating when the report resource was created.</p>
+     */
+    createdAt?: Date;
+    /**
+     * @public
+     * <p>Timestamp indicating when the report resource was last modified.</p>
+     */
+    lastModifiedAt?: Date;
+    /**
+     * @public
+     * <p>Timestamp indicating when the report resource was deleted.</p>
+     */
+    deletedAt?: Date;
+    /**
+     * @public
+     * <p>Current state of the report resource</p>
+     */
+    state?: PublishedState;
+    /**
+     * @public
+     * <p>ARN for the report resource.</p>
+     */
+    arn?: string;
+    /**
+     * @public
+     * <p>Series for the report resource.</p>
+     */
+    series?: string;
+    /**
+     * @public
+     * <p>Category for the report resource.</p>
+     */
+    category?: string;
+    /**
+     * @public
+     * <p>Associated company name for the report resource.</p>
+     */
+    companyName?: string;
+    /**
+     * @public
+     * <p>Associated product name for the report resource.</p>
+     */
+    productName?: string;
+    /**
+     * @public
+     * <p>Unique resource ARN for term resource.</p>
+     */
+    termArn?: string;
+    /**
+     * @public
+     * <p>Version for the report resource.</p>
+     */
+    version?: number;
+    /**
+     * @public
+     * <p>Acceptance type for report.</p>
+     */
+    acceptanceType?: AcceptanceType;
+    /**
+     * @public
+     * <p>Sequence number to enforce optimistic locking.</p>
+     */
+    sequenceNumber?: number;
+    /**
+     * @public
+     * <p>The current state of the document upload.</p>
+     */
+    uploadState?: UploadState;
+    /**
+     * @public
+     * <p>The message associated with the current upload state.</p>
+     */
+    statusMessage?: string;
+}
+/**
+ * @public
+ */
+export interface GetReportMetadataResponse {
+    /**
+     * @public
+     * <p>Report resource detail.</p>
+     */
+    reportDetails?: ReportDetail;
+}
+/**
+ * @public
+ */
+export interface GetTermForReportRequest {
+    /**
+     * @public
+     * <p>Unique resource ID for the report resource.</p>
+     */
+    reportId: string | undefined;
+    /**
+     * @public
+     * <p>Version for the report resource.</p>
+     */
+    reportVersion?: number;
+}
+/**
+ * @public
+ */
+export interface GetTermForReportResponse {
+    /**
+     * @public
+     * <p>Presigned S3 url to access the term content.</p>
+     */
+    documentPresignedUrl?: string;
+    /**
+     * @public
+     * <p>Unique token representing this request event.</p>
+     */
+    termToken?: string;
+}
+/**
+ * @public
+ */
+export interface ListReportsRequest {
+    /**
+     * @public
+     * <p>Maximum number of resources to return in the paginated response.</p>
+     */
+    maxResults?: number;
+    /**
+     * @public
+     * <p>Pagination token to request the next page of resources.</p>
+     */
+    nextToken?: string;
+}
+/**
+ * @public
+ * <p>Summary for report resource.</p>
+ */
+export interface ReportSummary {
+    /**
+     * @public
+     * <p>Unique resource ID for the report resource.</p>
+     */
+    id?: string;
+    /**
+     * @public
+     * <p>Name for the report resource.</p>
+     */
+    name?: string;
+    /**
+     * @public
+     * <p>Current state of the report resource.</p>
+     */
+    state?: PublishedState;
+    /**
+     * @public
+     * <p>ARN for the report resource.</p>
+     */
+    arn?: string;
+    /**
+     * @public
+     * <p>Version for the report resource.</p>
+     */
+    version?: number;
+    /**
+     * @public
+     * <p>The current state of the document upload.</p>
+     */
+    uploadState?: UploadState;
+    /**
+     * @public
+     * <p>Description for the report resource.</p>
+     */
+    description?: string;
+    /**
+     * @public
+     * <p>Timestamp indicating the report resource effective start.</p>
+     */
+    periodStart?: Date;
+    /**
+     * @public
+     * <p>Timestamp indicating the report resource effective end.</p>
+     */
+    periodEnd?: Date;
+    /**
+     * @public
+     * <p>Series for the report resource.</p>
+     */
+    series?: string;
+    /**
+     * @public
+     * <p>Category for the report resource.</p>
+     */
+    category?: string;
+    /**
+     * @public
+     * <p>Associated company name for the report resource.</p>
+     */
+    companyName?: string;
+    /**
+     * @public
+     * <p>Associated product name for the report resource.</p>
+     */
+    productName?: string;
+    /**
+     * @public
+     * <p>The message associated with the current upload state.</p>
+     */
+    statusMessage?: string;
+}
+/**
+ * @public
+ */
+export interface ListReportsResponse {
+    /**
+     * @public
+     * <p>List of report resources.</p>
+     */
+    reports?: ReportSummary[];
+    /**
+     * @public
+     * <p>Pagination token to request the next page of resources.</p>
+     */
+    nextToken?: string;
+}

package/dist-types/pagination/Interfaces.d.ts

@@ -0,0 +1,8 @@
+import { PaginationConfiguration } from "@smithy/types";
+import { ArtifactClient } from "../ArtifactClient";
+/**
+ * @public
+ */
+export interface ArtifactPaginationConfiguration extends PaginationConfiguration {
+    client: ArtifactClient;
+}

package/dist-types/pagination/ListReportsPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListReportsCommandInput, ListReportsCommandOutput } from "../commands/ListReportsCommand";
+import { ArtifactPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListReports: (config: ArtifactPaginationConfiguration, input: ListReportsCommandInput, ...rest: any[]) => Paginator<ListReportsCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Interfaces";
+export * from "./ListReportsPaginator";

package/dist-types/protocols/Aws_restJson1.d.ts

@@ -0,0 +1,56 @@
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
+import { SerdeContext as __SerdeContext } from "@smithy/types";
+import { GetAccountSettingsCommandInput, GetAccountSettingsCommandOutput } from "../commands/GetAccountSettingsCommand";
+import { GetReportCommandInput, GetReportCommandOutput } from "../commands/GetReportCommand";
+import { GetReportMetadataCommandInput, GetReportMetadataCommandOutput } from "../commands/GetReportMetadataCommand";
+import { GetTermForReportCommandInput, GetTermForReportCommandOutput } from "../commands/GetTermForReportCommand";
+import { ListReportsCommandInput, ListReportsCommandOutput } from "../commands/ListReportsCommand";
+import { PutAccountSettingsCommandInput, PutAccountSettingsCommandOutput } from "../commands/PutAccountSettingsCommand";
+/**
+ * serializeAws_restJson1GetAccountSettingsCommand
+ */
+export declare const se_GetAccountSettingsCommand: (input: GetAccountSettingsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetReportCommand
+ */
+export declare const se_GetReportCommand: (input: GetReportCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetReportMetadataCommand
+ */
+export declare const se_GetReportMetadataCommand: (input: GetReportMetadataCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetTermForReportCommand
+ */
+export declare const se_GetTermForReportCommand: (input: GetTermForReportCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1ListReportsCommand
+ */
+export declare const se_ListReportsCommand: (input: ListReportsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1PutAccountSettingsCommand
+ */
+export declare const se_PutAccountSettingsCommand: (input: PutAccountSettingsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * deserializeAws_restJson1GetAccountSettingsCommand
+ */
+export declare const de_GetAccountSettingsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetAccountSettingsCommandOutput>;
+/**
+ * deserializeAws_restJson1GetReportCommand
+ */
+export declare const de_GetReportCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetReportCommandOutput>;
+/**
+ * deserializeAws_restJson1GetReportMetadataCommand
+ */
+export declare const de_GetReportMetadataCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetReportMetadataCommandOutput>;
+/**
+ * deserializeAws_restJson1GetTermForReportCommand
+ */
+export declare const de_GetTermForReportCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetTermForReportCommandOutput>;
+/**
+ * deserializeAws_restJson1ListReportsCommand
+ */
+export declare const de_ListReportsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListReportsCommandOutput>;
+/**
+ * deserializeAws_restJson1PutAccountSettingsCommand
+ */
+export declare const de_PutAccountSettingsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<PutAccountSettingsCommandOutput>;