@aws-sdk/client-appstream 3.43.0 → 3.47.1

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

@@ -1,4 +1,5 @@
 export * from "./AssociateApplicationFleetCommand";
+export * from "./AssociateApplicationToEntitlementCommand";
 export * from "./AssociateFleetCommand";
 export * from "./BatchAssociateUserStackCommand";
 export * from "./BatchDisassociateUserStackCommand";
@@ -6,6 +7,7 @@ export * from "./CopyImageCommand";
 export * from "./CreateAppBlockCommand";
 export * from "./CreateApplicationCommand";
 export * from "./CreateDirectoryConfigCommand";
+export * from "./CreateEntitlementCommand";
 export * from "./CreateFleetCommand";
 export * from "./CreateImageBuilderCommand";
 export * from "./CreateImageBuilderStreamingURLCommand";
@@ -17,6 +19,7 @@ export * from "./CreateUserCommand";
 export * from "./DeleteAppBlockCommand";
 export * from "./DeleteApplicationCommand";
 export * from "./DeleteDirectoryConfigCommand";
+export * from "./DeleteEntitlementCommand";
 export * from "./DeleteFleetCommand";
 export * from "./DeleteImageBuilderCommand";
 export * from "./DeleteImageCommand";
@@ -28,6 +31,7 @@ export * from "./DescribeAppBlocksCommand";
 export * from "./DescribeApplicationFleetAssociationsCommand";
 export * from "./DescribeApplicationsCommand";
 export * from "./DescribeDirectoryConfigsCommand";
+export * from "./DescribeEntitlementsCommand";
 export * from "./DescribeFleetsCommand";
 export * from "./DescribeImageBuildersCommand";
 export * from "./DescribeImagePermissionsCommand";
@@ -39,11 +43,13 @@ export * from "./DescribeUserStackAssociationsCommand";
 export * from "./DescribeUsersCommand";
 export * from "./DisableUserCommand";
 export * from "./DisassociateApplicationFleetCommand";
+export * from "./DisassociateApplicationFromEntitlementCommand";
 export * from "./DisassociateFleetCommand";
 export * from "./EnableUserCommand";
 export * from "./ExpireSessionCommand";
 export * from "./ListAssociatedFleetsCommand";
 export * from "./ListAssociatedStacksCommand";
+export * from "./ListEntitledApplicationsCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./StartFleetCommand";
 export * from "./StartImageBuilderCommand";
@@ -53,6 +59,7 @@ export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateApplicationCommand";
 export * from "./UpdateDirectoryConfigCommand";
+export * from "./UpdateEntitlementCommand";
 export * from "./UpdateFleetCommand";
 export * from "./UpdateImagePermissionsCommand";
 export * from "./UpdateStackCommand";

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

@@ -261,6 +261,10 @@ export declare namespace ApplicationSettingsResponse {
      */
     const filterSensitiveLog: (obj: ApplicationSettingsResponse) => any;
 }
+export declare enum AppVisibility {
+    ALL = "ALL",
+    ASSOCIATED = "ASSOCIATED"
+}
 export interface AssociateApplicationFleetRequest {
     /**
      * <p>The name of the fleet.</p>
@@ -302,12 +306,6 @@ export interface ConcurrentModificationException extends __SmithyException, $Met
      */
     Message?: string;
 }
-export declare namespace ConcurrentModificationException {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ConcurrentModificationException) => any;
-}
 /**
  * <p>Indicates an incorrect combination of parameters, or a missing parameter.</p>
  */
@@ -319,12 +317,6 @@ export interface InvalidParameterCombinationException extends __SmithyException,
      */
     Message?: string;
 }
-export declare namespace InvalidParameterCombinationException {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: InvalidParameterCombinationException) => any;
-}
 /**
  * <p>The requested limit exceeds the permitted limit for an account.</p>
  */
@@ -336,12 +328,6 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear
      */
     Message?: string;
 }
-export declare namespace LimitExceededException {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: LimitExceededException) => any;
-}
 /**
  * <p>The attempted operation is not permitted.</p>
  */
@@ -353,12 +339,6 @@ export interface OperationNotPermittedException extends __SmithyException, $Meta
      */
     Message?: string;
 }
-export declare namespace OperationNotPermittedException {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: OperationNotPermittedException) => any;
-}
 /**
  * <p>The specified resource was not found.</p>
  */
@@ -370,11 +350,44 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB
      */
     Message?: string;
 }
-export declare namespace ResourceNotFoundException {
+export interface AssociateApplicationToEntitlementRequest {
+    /**
+     * <p>The name of the stack.</p>
+     */
+    StackName: string | undefined;
+    /**
+     * <p>The name of the entitlement.</p>
+     */
+    EntitlementName: string | undefined;
+    /**
+     * <p>The identifier of the application.</p>
+     */
+    ApplicationIdentifier: string | undefined;
+}
+export declare namespace AssociateApplicationToEntitlementRequest {
     /**
      * @internal
      */
-    const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
+    const filterSensitiveLog: (obj: AssociateApplicationToEntitlementRequest) => any;
+}
+export interface AssociateApplicationToEntitlementResult {
+}
+export declare namespace AssociateApplicationToEntitlementResult {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: AssociateApplicationToEntitlementResult) => any;
+}
+/**
+ * <p>The entitlement can't be found.</p>
+ */
+export interface EntitlementNotFoundException extends __SmithyException, $MetadataBearer {
+    name: "EntitlementNotFoundException";
+    $fault: "client";
+    /**
+     * <p>The error message in the exception.</p>
+     */
+    Message?: string;
 }
 export interface AssociateFleetRequest {
     /**
@@ -411,12 +424,6 @@ export interface IncompatibleImageException extends __SmithyException, $Metadata
      */
     Message?: string;
 }
-export declare namespace IncompatibleImageException {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: IncompatibleImageException) => any;
-}
 /**
  * <p>The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support. </p>
  */
@@ -428,12 +435,6 @@ export interface InvalidAccountStatusException extends __SmithyException, $Metad
      */
     Message?: string;
 }
-export declare namespace InvalidAccountStatusException {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: InvalidAccountStatusException) => any;
-}
 export declare enum AuthenticationType {
     API = "API",
     SAML = "SAML",
@@ -637,12 +638,6 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta
      */
     Message?: string;
 }
-export declare namespace ResourceAlreadyExistsException {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ResourceAlreadyExistsException) => any;
-}
 /**
  * <p>The specified resource exists and is not in use, but isn't available.</p>
  */
@@ -654,12 +649,6 @@ export interface ResourceNotAvailableException extends __SmithyException, $Metad
      */
     Message?: string;
 }
-export declare namespace ResourceNotAvailableException {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ResourceNotAvailableException) => any;
-}
 export interface CreateAppBlockRequest {
     /**
      * <p>The name of the app block.</p>
@@ -863,11 +852,149 @@ export interface InvalidRoleException extends __SmithyException, $MetadataBearer
      */
     Message?: string;
 }
-export declare namespace InvalidRoleException {
+/**
+ * <p>An attribute associated with an entitlement. Application entitlements work by matching
+ *             a supported SAML 2.0 attribute name to a value when a user identity federates to an
+ *             Amazon AppStream 2.0 SAML application.</p>
+ */
+export interface EntitlementAttribute {
+    /**
+     * <p>A supported AWS IAM SAML <code>PrincipalTag</code> attribute that is matched to the
+     *             associated value when a user identity federates into an Amazon AppStream 2.0 SAML
+     *             application.</p>
+     *         <p>The following are valid values:</p>
+     *         <ul>
+     *             <li>
+     *                <p>roles</p>
+     *             </li>
+     *             <li>
+     *                <p>department </p>
+     *             </li>
+     *             <li>
+     *                <p>organization </p>
+     *             </li>
+     *             <li>
+     *                <p>groups </p>
+     *             </li>
+     *             <li>
+     *                <p>title </p>
+     *             </li>
+     *             <li>
+     *                <p>costCenter </p>
+     *             </li>
+     *             <li>
+     *                <p>userType</p>
+     *             </li>
+     *          </ul>
+     *         <p> </p>
+     */
+    Name: string | undefined;
+    /**
+     * <p>A value that is matched to a supported SAML attribute name when a user identity
+     *             federates into an Amazon AppStream 2.0 SAML application. </p>
+     */
+    Value: string | undefined;
+}
+export declare namespace EntitlementAttribute {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: EntitlementAttribute) => any;
+}
+export interface CreateEntitlementRequest {
+    /**
+     * <p>The name of the entitlement.</p>
+     */
+    Name: string | undefined;
+    /**
+     * <p>The name of the stack with which the entitlement is associated.</p>
+     */
+    StackName: string | undefined;
+    /**
+     * <p>The description of the entitlement.</p>
+     */
+    Description?: string;
+    /**
+     * <p>Specifies whether all or selected apps are entitled.</p>
+     */
+    AppVisibility: AppVisibility | string | undefined;
+    /**
+     * <p>The attributes of the entitlement.</p>
+     */
+    Attributes: EntitlementAttribute[] | undefined;
+}
+export declare namespace CreateEntitlementRequest {
     /**
      * @internal
      */
-    const filterSensitiveLog: (obj: InvalidRoleException) => any;
+    const filterSensitiveLog: (obj: CreateEntitlementRequest) => any;
+}
+/**
+ * <p>Specifies an entitlement. Entitlements control access to specific applications within
+ *             a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user
+ *             identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all
+ *             applications in a stack. Entitlements don't apply to the desktop stream view
+ *             application, or to applications managed by a dynamic app provider using the Dynamic
+ *             Application Framework.</p>
+ */
+export interface Entitlement {
+    /**
+     * <p>The name of the entitlement.</p>
+     */
+    Name: string | undefined;
+    /**
+     * <p>The name of the stack with which the entitlement is associated.</p>
+     */
+    StackName: string | undefined;
+    /**
+     * <p>The description of the entitlement.</p>
+     */
+    Description?: string;
+    /**
+     * <p>Specifies whether all or selected apps are entitled.</p>
+     */
+    AppVisibility: AppVisibility | string | undefined;
+    /**
+     * <p>The attributes of the entitlement.</p>
+     */
+    Attributes: EntitlementAttribute[] | undefined;
+    /**
+     * <p>The time when the entitlement was created.</p>
+     */
+    CreatedTime?: Date;
+    /**
+     * <p>The time when the entitlement was last modified.</p>
+     */
+    LastModifiedTime?: Date;
+}
+export declare namespace Entitlement {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: Entitlement) => any;
+}
+export interface CreateEntitlementResult {
+    /**
+     * <p>The entitlement.</p>
+     */
+    Entitlement?: Entitlement;
+}
+export declare namespace CreateEntitlementResult {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: CreateEntitlementResult) => any;
+}
+/**
+ * <p>The entitlement already exists.</p>
+ */
+export interface EntitlementAlreadyExistsException extends __SmithyException, $MetadataBearer {
+    name: "EntitlementAlreadyExistsException";
+    $fault: "client";
+    /**
+     * <p>The error message in the exception.</p>
+     */
+    Message?: string;
 }
 /**
  * <p>Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.</p>
@@ -1474,12 +1601,6 @@ export interface RequestLimitExceededException extends __SmithyException, $Metad
      */
     Message?: string;
 }
-export declare namespace RequestLimitExceededException {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: RequestLimitExceededException) => any;
-}
 export interface CreateImageBuilderRequest {
     /**
      * <p>A unique name for the image builder.</p>
@@ -2525,12 +2646,6 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear
      */
     Message?: string;
 }
-export declare namespace ResourceInUseException {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ResourceInUseException) => any;
-}
 export interface DeleteApplicationRequest {
     /**
      * <p>The name of the application.</p>
@@ -2571,6 +2686,30 @@ export declare namespace DeleteDirectoryConfigResult {
      */
     const filterSensitiveLog: (obj: DeleteDirectoryConfigResult) => any;
 }
+export interface DeleteEntitlementRequest {
+    /**
+     * <p>The name of the entitlement.</p>
+     */
+    Name: string | undefined;
+    /**
+     * <p>The name of the stack with which the entitlement is associated.</p>
+     */
+    StackName: string | undefined;
+}
+export declare namespace DeleteEntitlementRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DeleteEntitlementRequest) => any;
+}
+export interface DeleteEntitlementResult {
+}
+export declare namespace DeleteEntitlementResult {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DeleteEntitlementResult) => any;
+}
 export interface DeleteFleetRequest {
     /**
      * <p>The name of the fleet.</p>
@@ -2881,6 +3020,47 @@ export declare namespace DescribeDirectoryConfigsResult {
      */
     const filterSensitiveLog: (obj: DescribeDirectoryConfigsResult) => any;
 }
+export interface DescribeEntitlementsRequest {
+    /**
+     * <p>The name of the entitlement.</p>
+     */
+    Name?: string;
+    /**
+     * <p>The name of the stack with which the entitlement is associated.</p>
+     */
+    StackName: string | undefined;
+    /**
+     * <p>The pagination token used to retrieve the next page of results for this operation.</p>
+     */
+    NextToken?: string;
+    /**
+     * <p>The maximum size of each page of results.</p>
+     */
+    MaxResults?: number;
+}
+export declare namespace DescribeEntitlementsRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DescribeEntitlementsRequest) => any;
+}
+export interface DescribeEntitlementsResult {
+    /**
+     * <p>The entitlements.</p>
+     */
+    Entitlements?: Entitlement[];
+    /**
+     * <p>The pagination token used to retrieve the next page of results for this
+     *             operation.</p>
+     */
+    NextToken?: string;
+}
+export declare namespace DescribeEntitlementsResult {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DescribeEntitlementsResult) => any;
+}
 export interface DescribeFleetsRequest {
     /**
      * <p>The names of the fleets to describe.</p>
@@ -3488,6 +3668,34 @@ export declare namespace DisassociateApplicationFleetResult {
      */
     const filterSensitiveLog: (obj: DisassociateApplicationFleetResult) => any;
 }
+export interface DisassociateApplicationFromEntitlementRequest {
+    /**
+     * <p>The name of the stack with which the entitlement is associated.</p>
+     */
+    StackName: string | undefined;
+    /**
+     * <p>The name of the entitlement.</p>
+     */
+    EntitlementName: string | undefined;
+    /**
+     * <p>The identifier of the application to remove from the entitlement.</p>
+     */
+    ApplicationIdentifier: string | undefined;
+}
+export declare namespace DisassociateApplicationFromEntitlementRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DisassociateApplicationFromEntitlementRequest) => any;
+}
+export interface DisassociateApplicationFromEntitlementResult {
+}
+export declare namespace DisassociateApplicationFromEntitlementResult {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DisassociateApplicationFromEntitlementResult) => any;
+}
 export interface DisassociateFleetRequest {
     /**
      * <p>The name of the fleet.</p>
@@ -3540,6 +3748,21 @@ export declare namespace EnableUserResult {
      */
     const filterSensitiveLog: (obj: EnableUserResult) => any;
 }
+/**
+ * <p>The application associated to an entitlement. Access is controlled based on user attributes.</p>
+ */
+export interface EntitledApplication {
+    /**
+     * <p>The identifier of the application.</p>
+     */
+    ApplicationIdentifier: string | undefined;
+}
+export declare namespace EntitledApplication {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: EntitledApplication) => any;
+}
 export interface ExpireSessionRequest {
     /**
      * <p>The identifier of the streaming session.</p>
@@ -3631,6 +3854,46 @@ export declare namespace ListAssociatedStacksResult {
      */
     const filterSensitiveLog: (obj: ListAssociatedStacksResult) => any;
 }
+export interface ListEntitledApplicationsRequest {
+    /**
+     * <p>The name of the stack with which the entitlement is associated.</p>
+     */
+    StackName: string | undefined;
+    /**
+     * <p>The name of the entitlement.</p>
+     */
+    EntitlementName: string | undefined;
+    /**
+     * <p>The pagination token used to retrieve the next page of results for this operation.</p>
+     */
+    NextToken?: string;
+    /**
+     * <p>The maximum size of each page of results.</p>
+     */
+    MaxResults?: number;
+}
+export declare namespace ListEntitledApplicationsRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: ListEntitledApplicationsRequest) => any;
+}
+export interface ListEntitledApplicationsResult {
+    /**
+     * <p>The entitled applications.</p>
+     */
+    EntitledApplications?: EntitledApplication[];
+    /**
+     * <p>The pagination token used to retrieve the next page of results for this operation.</p>
+     */
+    NextToken?: string;
+}
+export declare namespace ListEntitledApplicationsResult {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: ListEntitledApplicationsResult) => any;
+}
 export interface ListTagsForResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource.</p>
@@ -3892,6 +4155,46 @@ export declare namespace UpdateDirectoryConfigResult {
      */
     const filterSensitiveLog: (obj: UpdateDirectoryConfigResult) => any;
 }
+export interface UpdateEntitlementRequest {
+    /**
+     * <p>The name of the entitlement.</p>
+     */
+    Name: string | undefined;
+    /**
+     * <p>The name of the stack with which the entitlement is associated.</p>
+     */
+    StackName: string | undefined;
+    /**
+     * <p>The description of the entitlement.</p>
+     */
+    Description?: string;
+    /**
+     * <p>Specifies whether all or only selected apps are entitled.</p>
+     */
+    AppVisibility?: AppVisibility | string;
+    /**
+     * <p>The attributes of the entitlement.</p>
+     */
+    Attributes?: EntitlementAttribute[];
+}
+export declare namespace UpdateEntitlementRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: UpdateEntitlementRequest) => any;
+}
+export interface UpdateEntitlementResult {
+    /**
+     * <p>The entitlement.</p>
+     */
+    Entitlement?: Entitlement;
+}
+export declare namespace UpdateEntitlementResult {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: UpdateEntitlementResult) => any;
+}
 export interface UpdateFleetRequest {
     /**
      * <p>The name of the image used to create the fleet.</p>