@aws-sdk/client-lightsail 3.279.0 → 3.281.0

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

@@ -303,9 +303,24 @@ export interface AddOn {
      *       after.</p>
      */
     nextSnapshotTimeOfDay?: string;
+    /**
+     * <p>The trigger threshold of the action.</p>
+     *          <important>
+     *             <p>This add-on only applies to Lightsail for Research resources.</p>
+     *          </important>
+     */
+    threshold?: string;
+    /**
+     * <p>The amount of idle time in minutes after which your virtual computer will automatically stop.</p>
+     *          <important>
+     *             <p>This add-on only applies to Lightsail for Research resources.</p>
+     *          </important>
+     */
+    duration?: string;
 }
 export declare enum AddOnType {
-    AutoSnapshot = "AutoSnapshot"
+    AutoSnapshot = "AutoSnapshot",
+    StopInstanceOnIdle = "StopInstanceOnIdle"
 }
 /**
  * <p>Describes a request to enable or modify the automatic snapshot add-on for an
@@ -361,6 +376,22 @@ export interface AutoSnapshotAddOnRequest {
      */
     snapshotTimeOfDay?: string;
 }
+/**
+ * <p>Describes a request to create or edit the <code>StopInstanceOnIdle</code> add-on.</p>
+ *          <important>
+ *             <p>This add-on only applies to Lightsail for Research resources.</p>
+ *          </important>
+ */
+export interface StopInstanceOnIdleRequest {
+    /**
+     * <p>The value to compare with the duration.</p>
+     */
+    threshold?: string;
+    /**
+     * <p>The amount of idle time in minutes after which your virtual computer will automatically stop.</p>
+     */
+    duration?: string;
+}
 /**
  * <p>Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail
  *       resource.</p>
@@ -380,6 +411,14 @@ export interface AddOnRequest {
      *       snapshot add-on.</p>
      */
     autoSnapshotAddOnRequest?: AutoSnapshotAddOnRequest;
+    /**
+     * <p>An object that represents additional parameters when enabling or modifying the
+     *         <code>StopInstanceOnIdle</code> add-on.</p>
+     *          <important>
+     *             <p>This object only applies to Lightsail for Research resources.</p>
+     *          </important>
+     */
+    stopInstanceOnIdleRequest?: StopInstanceOnIdleRequest;
 }
 export declare enum ComparisonOperator {
     GreaterThanOrEqualToThreshold = "GreaterThanOrEqualToThreshold",
@@ -772,8 +811,10 @@ export declare enum OperationType {
     SendContactMethodVerification = "SendContactMethodVerification",
     SetIpAddressType = "SetIpAddressType",
     SetResourceAccessForBucket = "SetResourceAccessForBucket",
+    StartGUISession = "StartGUISession",
     StartInstance = "StartInstance",
     StartRelationalDatabase = "StartRelationalDatabase",
+    StopGUISession = "StopGUISession",
     StopInstance = "StopInstance",
     StopRelationalDatabase = "StopRelationalDatabase",
     TestAlarm = "TestAlarm",
@@ -933,6 +974,9 @@ export declare class UnauthenticatedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<UnauthenticatedException, __BaseException>);
 }
+export declare enum AppCategory {
+    LfR = "LfR"
+}
 export interface AttachCertificateToDistributionRequest {
     /**
      * <p>The name of the distribution that the certificate will be attached to.</p>
@@ -976,6 +1020,14 @@ export interface AttachDiskRequest {
      * <p>The disk path to expose to the instance (e.g., <code>/dev/xvdf</code>).</p>
      */
     diskPath: string | undefined;
+    /**
+     * <p>A Boolean value used to determine the automatic mounting of a storage volume to a virtual
+     *       computer. The default value is <code>False</code>.</p>
+     *          <important>
+     *             <p>This value only applies to Lightsail for Research resources.</p>
+     *          </important>
+     */
+    autoMounting?: boolean;
 }
 export interface AttachDiskResult {
     /**
@@ -1072,6 +1124,12 @@ export interface AttachStaticIpResult {
      */
     operations?: Operation[];
 }
+export declare enum AutoMountStatus {
+    Failed = "Failed",
+    Mounted = "Mounted",
+    NotMounted = "NotMounted",
+    Pending = "Pending"
+}
 export declare enum AutoSnapshotStatus {
     FAILED = "Failed",
     IN_PROGRESS = "InProgress",
@@ -1188,6 +1246,13 @@ export interface Blueprint {
      *       blueprint.</p>
      */
     platform?: InstancePlatform | string;
+    /**
+     * <p>Virtual computer blueprints that are supported by Lightsail for Research.</p>
+     *          <important>
+     *             <p>This parameter only applies to Lightsail for Research resources.</p>
+     *          </important>
+     */
+    appCategory?: AppCategory | string;
 }
 /**
  * <p>Describes the access log configuration for a bucket in the Amazon Lightsail object storage
@@ -1461,6 +1526,13 @@ export interface Bundle {
      *         <code>LINUX_UNIX</code> bundle.</p>
      */
     supportedPlatforms?: (InstancePlatform | string)[];
+    /**
+     * <p>Virtual computer blueprints that are supported by a Lightsail for Research bundle.</p>
+     *          <important>
+     *             <p>This parameter only applies to Lightsail for Research resources.</p>
+     *          </important>
+     */
+    supportedAppCategories?: (AppCategory | string)[];
 }
 /**
  * <p>Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN)
@@ -3112,6 +3184,69 @@ export interface CopySnapshotResult {
      */
     operations?: Operation[];
 }
+export declare enum Currency {
+    USD = "USD"
+}
+export declare enum PricingUnit {
+    Bundles = "Bundles",
+    GB = "GB",
+    GBMo = "GB-Mo",
+    Hrs = "Hrs",
+    Queries = "Queries"
+}
+/**
+ * <p>Sets the start date and end date for retrieving a cost estimate. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>
+ */
+export interface TimePeriod {
+    /**
+     * <p>The beginning of the time period. The start date is inclusive. For example, if <code>start</code> is <code>2017-01-01</code>, Lightsail for Research retrieves cost and usage data starting at <code>2017-01-01</code> up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.</p>
+     */
+    start?: Date;
+    /**
+     * <p>The end of the time period. The end date is exclusive. For example, if <code>end</code> is <code>2017-05-01</code>, Lightsail for Research retrieves cost and usage data from the start date up to, but not including, <code>2017-05-01</code>.</p>
+     */
+    end?: Date;
+}
+/**
+ * <p>An estimate that's associated with a time period. </p>
+ */
+export interface EstimateByTime {
+    /**
+     * <p>The amount of cost or usage that's measured for the cost estimate.</p>
+     */
+    usageCost?: number;
+    /**
+     * <p>The unit of measurement that's used for the cost estimate.</p>
+     */
+    pricingUnit?: PricingUnit | string;
+    /**
+     * <p>The number of pricing units used to calculate the total number of hours. For example, 1
+     *       unit equals 1 hour.</p>
+     */
+    unit?: number;
+    /**
+     * <p>The currency of the estimate in USD.</p>
+     */
+    currency?: Currency | string;
+    /**
+     * <p>The period of time, in days, that an estimate covers. The period has a start date and an end date. The start date must come before the end date.</p>
+     */
+    timePeriod?: TimePeriod;
+}
+/**
+ * <p>Describes the estimated cost for resources in your Lightsail for Research account.</p>
+ */
+export interface CostEstimate {
+    /**
+     * <p>The types of usage that are included in the estimate, such as costs, usage, or data
+     *       transfer.</p>
+     */
+    usageType?: string;
+    /**
+     * <p>The cost estimate result that's associated with a time period.</p>
+     */
+    resultsByTime?: EstimateByTime[];
+}
 export interface CreateBucketRequest {
     /**
      * <p>The name for the bucket.</p>
@@ -3996,6 +4131,65 @@ export interface CreateDomainEntryResult {
      */
     operation?: Operation;
 }
+export interface CreateGUISessionAccessDetailsRequest {
+    /**
+     * <p>The resource name.</p>
+     */
+    resourceName: string | undefined;
+}
+/**
+ * <p>Describes a web-based, remote graphical user interface (GUI), NICE DCV session. The session is used to access a virtual
+ *       computer’s operating system or application.</p>
+ */
+export interface Session {
+    /**
+     * <p>The session name.</p>
+     */
+    name?: string;
+    /**
+     * <p>The session URL.</p>
+     */
+    url?: string;
+    /**
+     * <p>When true, this Boolean value indicates the primary session for the specified
+     *       resource.</p>
+     */
+    isPrimary?: boolean;
+}
+export declare enum Status {
+    FailedInstanceCreation = "failedInstanceCreation",
+    FailedStartingGUISession = "failedStartingGUISession",
+    FailedStoppingGUISession = "failedStoppingGUISession",
+    NotStarted = "notStarted",
+    SettingUpInstance = "settingUpInstance",
+    StartExpired = "startExpired",
+    Started = "started",
+    Starting = "starting",
+    Stopped = "stopped",
+    Stopping = "stopping"
+}
+export interface CreateGUISessionAccessDetailsResult {
+    /**
+     * <p>The resource name.</p>
+     */
+    resourceName?: string;
+    /**
+     * <p>The status of the operation.</p>
+     */
+    status?: Status | string;
+    /**
+     * <p>The percentage of completion for the operation.</p>
+     */
+    percentageComplete?: number;
+    /**
+     * <p>The reason the operation failed.</p>
+     */
+    failureReason?: string;
+    /**
+     * <p>Returns information about the specified NICE DCV GUI session.</p>
+     */
+    sessions?: Session[];
+}
 export interface CreateInstancesRequest {
     /**
      * <p>The names to use for your new Lightsail instances. Separate multiple values using
@@ -5295,6 +5489,13 @@ export interface Disk {
      *          </note>
      */
     gbInUse?: number;
+    /**
+     * <p>The status of automatically mounting a storage disk to a virtual computer.</p>
+     *          <important>
+     *             <p>This parameter only applies to Lightsail for Research resources.</p>
+     *          </important>
+     */
+    autoMountStatus?: AutoMountStatus | string;
 }
 /**
  * <p>Describes a disk.</p>
@@ -5837,6 +6038,13 @@ export interface GetBlueprintsRequest {
      *       page token in a subsequent request.</p>
      */
     pageToken?: string;
+    /**
+     * <p>Returns a list of blueprints that are specific to Lightsail for Research.</p>
+     *          <important>
+     *             <p>You must use this parameter to view Lightsail for Research blueprints.</p>
+     *          </important>
+     */
+    appCategory?: AppCategory | string;
 }
 export interface GetBlueprintsResult {
     /**
@@ -6069,6 +6277,13 @@ export interface GetBundlesRequest {
      *       token in a subsequent request.</p>
      */
     pageToken?: string;
+    /**
+     * <p>Returns a list of bundles that are specific to Lightsail for Research.</p>
+     *          <important>
+     *             <p>You must use this parameter to view Lightsail for Research bundles.</p>
+     *          </important>
+     */
+    appCategory?: AppCategory | string;
 }
 export interface GetBundlesResult {
     /**
@@ -6382,104 +6597,6 @@ export interface GetContainerServicesRequest {
      */
     serviceName?: string;
 }
-export interface GetDiskRequest {
-    /**
-     * <p>The name of the disk (e.g., <code>my-disk</code>).</p>
-     */
-    diskName: string | undefined;
-}
-export interface GetDiskResult {
-    /**
-     * <p>An object containing information about the disk.</p>
-     */
-    disk?: Disk;
-}
-export interface GetDisksRequest {
-    /**
-     * <p>The token to advance to the next page of results from your request.</p>
-     *          <p>To get a page token, perform an initial <code>GetDisks</code> request. If your results are
-     *       paginated, the response will return a next page token that you can specify as the page token
-     *       in a subsequent request.</p>
-     */
-    pageToken?: string;
-}
-export interface GetDisksResult {
-    /**
-     * <p>An array of objects containing information about all block storage disks.</p>
-     */
-    disks?: Disk[];
-    /**
-     * <p>The token to advance to the next page of results from your request.</p>
-     *          <p>A next page token is not returned if there are no more results to display.</p>
-     *          <p>To get the next page of results, perform another <code>GetDisks</code> request and specify
-     *       the next page token using the <code>pageToken</code> parameter.</p>
-     */
-    nextPageToken?: string;
-}
-export interface GetDiskSnapshotRequest {
-    /**
-     * <p>The name of the disk snapshot (e.g., <code>my-disk-snapshot</code>).</p>
-     */
-    diskSnapshotName: string | undefined;
-}
-export interface GetDiskSnapshotResult {
-    /**
-     * <p>An object containing information about the disk snapshot.</p>
-     */
-    diskSnapshot?: DiskSnapshot;
-}
-export interface GetDiskSnapshotsRequest {
-    /**
-     * <p>The token to advance to the next page of results from your request.</p>
-     *          <p>To get a page token, perform an initial <code>GetDiskSnapshots</code> request. If your
-     *       results are paginated, the response will return a next page token that you can specify as the
-     *       page token in a subsequent request.</p>
-     */
-    pageToken?: string;
-}
-export interface GetDiskSnapshotsResult {
-    /**
-     * <p>An array of objects containing information about all block storage disk snapshots.</p>
-     */
-    diskSnapshots?: DiskSnapshot[];
-    /**
-     * <p>The token to advance to the next page of results from your request.</p>
-     *          <p>A next page token is not returned if there are no more results to display.</p>
-     *          <p>To get the next page of results, perform another <code>GetDiskSnapshots</code> request and
-     *       specify the next page token using the <code>pageToken</code> parameter.</p>
-     */
-    nextPageToken?: string;
-}
-export interface GetDistributionBundlesRequest {
-}
-export interface GetDistributionBundlesResult {
-    /**
-     * <p>An object that describes a distribution bundle.</p>
-     */
-    bundles?: DistributionBundle[];
-}
-export interface GetDistributionLatestCacheResetRequest {
-    /**
-     * <p>The name of the distribution for which to return the timestamp of the last cache
-     *       reset.</p>
-     *          <p>Use the <code>GetDistributions</code> action to get a list of distribution names that you
-     *       can specify.</p>
-     *          <p>When omitted, the response includes the latest cache reset timestamp of all your
-     *       distributions.</p>
-     */
-    distributionName?: string;
-}
-export interface GetDistributionLatestCacheResetResult {
-    /**
-     * <p>The status of the last cache reset.</p>
-     */
-    status?: string;
-    /**
-     * <p>The timestamp of the last cache reset (e.g., <code>1479734909.17</code>) in Unix time
-     *       format.</p>
-     */
-    createTime?: Date;
-}
 /**
  * @internal
  */
@@ -6508,6 +6625,10 @@ export declare const AddOnFilterSensitiveLog: (obj: AddOn) => any;
  * @internal
  */
 export declare const AutoSnapshotAddOnRequestFilterSensitiveLog: (obj: AutoSnapshotAddOnRequest) => any;
+/**
+ * @internal
+ */
+export declare const StopInstanceOnIdleRequestFilterSensitiveLog: (obj: StopInstanceOnIdleRequest) => any;
 /**
  * @internal
  */
@@ -6768,6 +6889,18 @@ export declare const CopySnapshotRequestFilterSensitiveLog: (obj: CopySnapshotRe
  * @internal
  */
 export declare const CopySnapshotResultFilterSensitiveLog: (obj: CopySnapshotResult) => any;
+/**
+ * @internal
+ */
+export declare const TimePeriodFilterSensitiveLog: (obj: TimePeriod) => any;
+/**
+ * @internal
+ */
+export declare const EstimateByTimeFilterSensitiveLog: (obj: EstimateByTime) => any;
+/**
+ * @internal
+ */
+export declare const CostEstimateFilterSensitiveLog: (obj: CostEstimate) => any;
 /**
  * @internal
  */
@@ -6904,6 +7037,18 @@ export declare const CreateDomainEntryRequestFilterSensitiveLog: (obj: CreateDom
  * @internal
  */
 export declare const CreateDomainEntryResultFilterSensitiveLog: (obj: CreateDomainEntryResult) => any;
+/**
+ * @internal
+ */
+export declare const CreateGUISessionAccessDetailsRequestFilterSensitiveLog: (obj: CreateGUISessionAccessDetailsRequest) => any;
+/**
+ * @internal
+ */
+export declare const SessionFilterSensitiveLog: (obj: Session) => any;
+/**
+ * @internal
+ */
+export declare const CreateGUISessionAccessDetailsResultFilterSensitiveLog: (obj: CreateGUISessionAccessDetailsResult) => any;
 /**
  * @internal
  */
@@ -7412,51 +7557,3 @@ export declare const GetContainerServicePowersResultFilterSensitiveLog: (obj: Ge
  * @internal
  */
 export declare const GetContainerServicesRequestFilterSensitiveLog: (obj: GetContainerServicesRequest) => any;
-/**
- * @internal
- */
-export declare const GetDiskRequestFilterSensitiveLog: (obj: GetDiskRequest) => any;
-/**
- * @internal
- */
-export declare const GetDiskResultFilterSensitiveLog: (obj: GetDiskResult) => any;
-/**
- * @internal
- */
-export declare const GetDisksRequestFilterSensitiveLog: (obj: GetDisksRequest) => any;
-/**
- * @internal
- */
-export declare const GetDisksResultFilterSensitiveLog: (obj: GetDisksResult) => any;
-/**
- * @internal
- */
-export declare const GetDiskSnapshotRequestFilterSensitiveLog: (obj: GetDiskSnapshotRequest) => any;
-/**
- * @internal
- */
-export declare const GetDiskSnapshotResultFilterSensitiveLog: (obj: GetDiskSnapshotResult) => any;
-/**
- * @internal
- */
-export declare const GetDiskSnapshotsRequestFilterSensitiveLog: (obj: GetDiskSnapshotsRequest) => any;
-/**
- * @internal
- */
-export declare const GetDiskSnapshotsResultFilterSensitiveLog: (obj: GetDiskSnapshotsResult) => any;
-/**
- * @internal
- */
-export declare const GetDistributionBundlesRequestFilterSensitiveLog: (obj: GetDistributionBundlesRequest) => any;
-/**
- * @internal
- */
-export declare const GetDistributionBundlesResultFilterSensitiveLog: (obj: GetDistributionBundlesResult) => any;
-/**
- * @internal
- */
-export declare const GetDistributionLatestCacheResetRequestFilterSensitiveLog: (obj: GetDistributionLatestCacheResetRequest) => any;
-/**
- * @internal
- */
-export declare const GetDistributionLatestCacheResetResultFilterSensitiveLog: (obj: GetDistributionLatestCacheResetResult) => any;