Skip to content

AppStreamClient

Index > AppStream > AppStreamClient

Auto-generated documentation for AppStream type annotations stubs module mypy-boto3-appstream.

AppStreamClient

Type annotations and code completion for boto3.client("appstream"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_appstream.client import AppStreamClient

def get_appstream_client() -> AppStreamClient:
    return Session().client("appstream")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("appstream").exceptions structure.

Usage example
client = boto3.client("appstream")

try:
    do_something(client)
except (
    client.ClientError,
    client.ConcurrentModificationException,
    client.EntitlementAlreadyExistsException,
    client.EntitlementNotFoundException,
    client.IncompatibleImageException,
    client.InvalidAccountStatusException,
    client.InvalidParameterCombinationException,
    client.InvalidRoleException,
    client.LimitExceededException,
    client.OperationNotPermittedException,
    client.RequestLimitExceededException,
    client.ResourceAlreadyExistsException,
    client.ResourceInUseException,
    client.ResourceNotAvailableException,
    client.ResourceNotFoundException,
) as e:
    print(e)
Type checking example
from mypy_boto3_appstream.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

associate_application_fleet

Associates the specified application with the specified fleet.

Type annotations and code completion for boto3.client("appstream").associate_application_fleet method. boto3 documentation

Method definition
def associate_application_fleet(
    self,
    *,
    FleetName: str,
    ApplicationArn: str,
) -> AssociateApplicationFleetResultTypeDef:  # (1)
    ...
  1. See AssociateApplicationFleetResultTypeDef
Usage example with kwargs
kwargs: AssociateApplicationFleetRequestRequestTypeDef = {  # (1)
    "FleetName": ...,
    "ApplicationArn": ...,
}

parent.associate_application_fleet(**kwargs)
  1. See AssociateApplicationFleetRequestRequestTypeDef

associate_application_to_entitlement

Associates an application to entitle.

Type annotations and code completion for boto3.client("appstream").associate_application_to_entitlement method. boto3 documentation

Method definition
def associate_application_to_entitlement(
    self,
    *,
    StackName: str,
    EntitlementName: str,
    ApplicationIdentifier: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AssociateApplicationToEntitlementRequestRequestTypeDef = {  # (1)
    "StackName": ...,
    "EntitlementName": ...,
    "ApplicationIdentifier": ...,
}

parent.associate_application_to_entitlement(**kwargs)
  1. See AssociateApplicationToEntitlementRequestRequestTypeDef

associate_fleet

Associates the specified fleet with the specified stack.

Type annotations and code completion for boto3.client("appstream").associate_fleet method. boto3 documentation

Method definition
def associate_fleet(
    self,
    *,
    FleetName: str,
    StackName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AssociateFleetRequestRequestTypeDef = {  # (1)
    "FleetName": ...,
    "StackName": ...,
}

parent.associate_fleet(**kwargs)
  1. See AssociateFleetRequestRequestTypeDef

batch_associate_user_stack

Associates the specified users with the specified stacks.

Type annotations and code completion for boto3.client("appstream").batch_associate_user_stack method. boto3 documentation

Method definition
def batch_associate_user_stack(
    self,
    *,
    UserStackAssociations: Sequence[UserStackAssociationTypeDef],  # (1)
) -> BatchAssociateUserStackResultTypeDef:  # (2)
    ...
  1. See UserStackAssociationTypeDef
  2. See BatchAssociateUserStackResultTypeDef
Usage example with kwargs
kwargs: BatchAssociateUserStackRequestRequestTypeDef = {  # (1)
    "UserStackAssociations": ...,
}

parent.batch_associate_user_stack(**kwargs)
  1. See BatchAssociateUserStackRequestRequestTypeDef

batch_disassociate_user_stack

Disassociates the specified users from the specified stacks.

Type annotations and code completion for boto3.client("appstream").batch_disassociate_user_stack method. boto3 documentation

Method definition
def batch_disassociate_user_stack(
    self,
    *,
    UserStackAssociations: Sequence[UserStackAssociationTypeDef],  # (1)
) -> BatchDisassociateUserStackResultTypeDef:  # (2)
    ...
  1. See UserStackAssociationTypeDef
  2. See BatchDisassociateUserStackResultTypeDef
Usage example with kwargs
kwargs: BatchDisassociateUserStackRequestRequestTypeDef = {  # (1)
    "UserStackAssociations": ...,
}

parent.batch_disassociate_user_stack(**kwargs)
  1. See BatchDisassociateUserStackRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("appstream").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("appstream").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

copy_image

Copies the image within the same region or to a new region within the same AWS account.

Type annotations and code completion for boto3.client("appstream").copy_image method. boto3 documentation

Method definition
def copy_image(
    self,
    *,
    SourceImageName: str,
    DestinationImageName: str,
    DestinationRegion: str,
    DestinationImageDescription: str = ...,
) -> CopyImageResponseTypeDef:  # (1)
    ...
  1. See CopyImageResponseTypeDef
Usage example with kwargs
kwargs: CopyImageRequestRequestTypeDef = {  # (1)
    "SourceImageName": ...,
    "DestinationImageName": ...,
    "DestinationRegion": ...,
}

parent.copy_image(**kwargs)
  1. See CopyImageRequestRequestTypeDef

create_app_block

Creates an app block.

Type annotations and code completion for boto3.client("appstream").create_app_block method. boto3 documentation

Method definition
def create_app_block(
    self,
    *,
    Name: str,
    SourceS3Location: S3LocationTypeDef,  # (1)
    SetupScriptDetails: ScriptDetailsTypeDef,  # (2)
    Description: str = ...,
    DisplayName: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateAppBlockResultTypeDef:  # (3)
    ...
  1. See S3LocationTypeDef
  2. See ScriptDetailsTypeDef
  3. See CreateAppBlockResultTypeDef
Usage example with kwargs
kwargs: CreateAppBlockRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "SourceS3Location": ...,
    "SetupScriptDetails": ...,
}

parent.create_app_block(**kwargs)
  1. See CreateAppBlockRequestRequestTypeDef

create_application

Creates an application.

Type annotations and code completion for boto3.client("appstream").create_application method. boto3 documentation

Method definition
def create_application(
    self,
    *,
    Name: str,
    IconS3Location: S3LocationTypeDef,  # (1)
    LaunchPath: str,
    Platforms: Sequence[PlatformTypeType],  # (2)
    InstanceFamilies: Sequence[str],
    AppBlockArn: str,
    DisplayName: str = ...,
    Description: str = ...,
    WorkingDirectory: str = ...,
    LaunchParameters: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateApplicationResultTypeDef:  # (3)
    ...
  1. See S3LocationTypeDef
  2. See PlatformTypeType
  3. See CreateApplicationResultTypeDef
Usage example with kwargs
kwargs: CreateApplicationRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "IconS3Location": ...,
    "LaunchPath": ...,
    "Platforms": ...,
    "InstanceFamilies": ...,
    "AppBlockArn": ...,
}

parent.create_application(**kwargs)
  1. See CreateApplicationRequestRequestTypeDef

create_directory_config

Creates a Directory Config object in AppStream 2.0.

Type annotations and code completion for boto3.client("appstream").create_directory_config method. boto3 documentation

Method definition
def create_directory_config(
    self,
    *,
    DirectoryName: str,
    OrganizationalUnitDistinguishedNames: Sequence[str],
    ServiceAccountCredentials: ServiceAccountCredentialsTypeDef = ...,  # (1)
) -> CreateDirectoryConfigResultTypeDef:  # (2)
    ...
  1. See ServiceAccountCredentialsTypeDef
  2. See CreateDirectoryConfigResultTypeDef
Usage example with kwargs
kwargs: CreateDirectoryConfigRequestRequestTypeDef = {  # (1)
    "DirectoryName": ...,
    "OrganizationalUnitDistinguishedNames": ...,
}

parent.create_directory_config(**kwargs)
  1. See CreateDirectoryConfigRequestRequestTypeDef

create_entitlement

Creates a new entitlement.

Type annotations and code completion for boto3.client("appstream").create_entitlement method. boto3 documentation

Method definition
def create_entitlement(
    self,
    *,
    Name: str,
    StackName: str,
    AppVisibility: AppVisibilityType,  # (1)
    Attributes: Sequence[EntitlementAttributeTypeDef],  # (2)
    Description: str = ...,
) -> CreateEntitlementResultTypeDef:  # (3)
    ...
  1. See AppVisibilityType
  2. See EntitlementAttributeTypeDef
  3. See CreateEntitlementResultTypeDef
Usage example with kwargs
kwargs: CreateEntitlementRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "StackName": ...,
    "AppVisibility": ...,
    "Attributes": ...,
}

parent.create_entitlement(**kwargs)
  1. See CreateEntitlementRequestRequestTypeDef

create_fleet

Creates a fleet.

Type annotations and code completion for boto3.client("appstream").create_fleet method. boto3 documentation

Method definition
def create_fleet(
    self,
    *,
    Name: str,
    InstanceType: str,
    ImageName: str = ...,
    ImageArn: str = ...,
    FleetType: FleetTypeType = ...,  # (1)
    ComputeCapacity: ComputeCapacityTypeDef = ...,  # (2)
    VpcConfig: VpcConfigTypeDef = ...,  # (3)
    MaxUserDurationInSeconds: int = ...,
    DisconnectTimeoutInSeconds: int = ...,
    Description: str = ...,
    DisplayName: str = ...,
    EnableDefaultInternetAccess: bool = ...,
    DomainJoinInfo: DomainJoinInfoTypeDef = ...,  # (4)
    Tags: Mapping[str, str] = ...,
    IdleDisconnectTimeoutInSeconds: int = ...,
    IamRoleArn: str = ...,
    StreamView: StreamViewType = ...,  # (5)
    Platform: PlatformTypeType = ...,  # (6)
    MaxConcurrentSessions: int = ...,
    UsbDeviceFilterStrings: Sequence[str] = ...,
    SessionScriptS3Location: S3LocationTypeDef = ...,  # (7)
) -> CreateFleetResultTypeDef:  # (8)
    ...
  1. See FleetTypeType
  2. See ComputeCapacityTypeDef
  3. See VpcConfigTypeDef
  4. See DomainJoinInfoTypeDef
  5. See StreamViewType
  6. See PlatformTypeType
  7. See S3LocationTypeDef
  8. See CreateFleetResultTypeDef
Usage example with kwargs
kwargs: CreateFleetRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "InstanceType": ...,
}

parent.create_fleet(**kwargs)
  1. See CreateFleetRequestRequestTypeDef

create_image_builder

Creates an image builder.

Type annotations and code completion for boto3.client("appstream").create_image_builder method. boto3 documentation

Method definition
def create_image_builder(
    self,
    *,
    Name: str,
    InstanceType: str,
    ImageName: str = ...,
    ImageArn: str = ...,
    Description: str = ...,
    DisplayName: str = ...,
    VpcConfig: VpcConfigTypeDef = ...,  # (1)
    IamRoleArn: str = ...,
    EnableDefaultInternetAccess: bool = ...,
    DomainJoinInfo: DomainJoinInfoTypeDef = ...,  # (2)
    AppstreamAgentVersion: str = ...,
    Tags: Mapping[str, str] = ...,
    AccessEndpoints: Sequence[AccessEndpointTypeDef] = ...,  # (3)
) -> CreateImageBuilderResultTypeDef:  # (4)
    ...
  1. See VpcConfigTypeDef
  2. See DomainJoinInfoTypeDef
  3. See AccessEndpointTypeDef
  4. See CreateImageBuilderResultTypeDef
Usage example with kwargs
kwargs: CreateImageBuilderRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "InstanceType": ...,
}

parent.create_image_builder(**kwargs)
  1. See CreateImageBuilderRequestRequestTypeDef

create_image_builder_streaming_url

Creates a URL to start an image builder streaming session.

Type annotations and code completion for boto3.client("appstream").create_image_builder_streaming_url method. boto3 documentation

Method definition
def create_image_builder_streaming_url(
    self,
    *,
    Name: str,
    Validity: int = ...,
) -> CreateImageBuilderStreamingURLResultTypeDef:  # (1)
    ...
  1. See CreateImageBuilderStreamingURLResultTypeDef
Usage example with kwargs
kwargs: CreateImageBuilderStreamingURLRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_image_builder_streaming_url(**kwargs)
  1. See CreateImageBuilderStreamingURLRequestRequestTypeDef

create_stack

Creates a stack to start streaming applications to users.

Type annotations and code completion for boto3.client("appstream").create_stack method. boto3 documentation

Method definition
def create_stack(
    self,
    *,
    Name: str,
    Description: str = ...,
    DisplayName: str = ...,
    StorageConnectors: Sequence[StorageConnectorTypeDef] = ...,  # (1)
    RedirectURL: str = ...,
    FeedbackURL: str = ...,
    UserSettings: Sequence[UserSettingTypeDef] = ...,  # (2)
    ApplicationSettings: ApplicationSettingsTypeDef = ...,  # (3)
    Tags: Mapping[str, str] = ...,
    AccessEndpoints: Sequence[AccessEndpointTypeDef] = ...,  # (4)
    EmbedHostDomains: Sequence[str] = ...,
    StreamingExperienceSettings: StreamingExperienceSettingsTypeDef = ...,  # (5)
) -> CreateStackResultTypeDef:  # (6)
    ...
  1. See StorageConnectorTypeDef
  2. See UserSettingTypeDef
  3. See ApplicationSettingsTypeDef
  4. See AccessEndpointTypeDef
  5. See StreamingExperienceSettingsTypeDef
  6. See CreateStackResultTypeDef
Usage example with kwargs
kwargs: CreateStackRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_stack(**kwargs)
  1. See CreateStackRequestRequestTypeDef

create_streaming_url

Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user.

Type annotations and code completion for boto3.client("appstream").create_streaming_url method. boto3 documentation

Method definition
def create_streaming_url(
    self,
    *,
    StackName: str,
    FleetName: str,
    UserId: str,
    ApplicationId: str = ...,
    Validity: int = ...,
    SessionContext: str = ...,
) -> CreateStreamingURLResultTypeDef:  # (1)
    ...
  1. See CreateStreamingURLResultTypeDef
Usage example with kwargs
kwargs: CreateStreamingURLRequestRequestTypeDef = {  # (1)
    "StackName": ...,
    "FleetName": ...,
    "UserId": ...,
}

parent.create_streaming_url(**kwargs)
  1. See CreateStreamingURLRequestRequestTypeDef

create_updated_image

Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.

Type annotations and code completion for boto3.client("appstream").create_updated_image method. boto3 documentation

Method definition
def create_updated_image(
    self,
    *,
    existingImageName: str,
    newImageName: str,
    newImageDescription: str = ...,
    newImageDisplayName: str = ...,
    newImageTags: Mapping[str, str] = ...,
    dryRun: bool = ...,
) -> CreateUpdatedImageResultTypeDef:  # (1)
    ...
  1. See CreateUpdatedImageResultTypeDef
Usage example with kwargs
kwargs: CreateUpdatedImageRequestRequestTypeDef = {  # (1)
    "existingImageName": ...,
    "newImageName": ...,
}

parent.create_updated_image(**kwargs)
  1. See CreateUpdatedImageRequestRequestTypeDef

create_usage_report_subscription

Creates a usage report subscription.

Type annotations and code completion for boto3.client("appstream").create_usage_report_subscription method. boto3 documentation

Method definition
def create_usage_report_subscription(
    self,
) -> CreateUsageReportSubscriptionResultTypeDef:  # (1)
    ...
  1. See CreateUsageReportSubscriptionResultTypeDef

create_user

Creates a new user in the user pool.

Type annotations and code completion for boto3.client("appstream").create_user method. boto3 documentation

Method definition
def create_user(
    self,
    *,
    UserName: str,
    AuthenticationType: AuthenticationTypeType,  # (1)
    MessageAction: MessageActionType = ...,  # (2)
    FirstName: str = ...,
    LastName: str = ...,
) -> Dict[str, Any]:
    ...
  1. See AuthenticationTypeType
  2. See MessageActionType
Usage example with kwargs
kwargs: CreateUserRequestRequestTypeDef = {  # (1)
    "UserName": ...,
    "AuthenticationType": ...,
}

parent.create_user(**kwargs)
  1. See CreateUserRequestRequestTypeDef

delete_app_block

Deletes an app block.

Type annotations and code completion for boto3.client("appstream").delete_app_block method. boto3 documentation

Method definition
def delete_app_block(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteAppBlockRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_app_block(**kwargs)
  1. See DeleteAppBlockRequestRequestTypeDef

delete_application

Deletes an application.

Type annotations and code completion for boto3.client("appstream").delete_application method. boto3 documentation

Method definition
def delete_application(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteApplicationRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_application(**kwargs)
  1. See DeleteApplicationRequestRequestTypeDef

delete_directory_config

Deletes the specified Directory Config object from AppStream 2.0.

Type annotations and code completion for boto3.client("appstream").delete_directory_config method. boto3 documentation

Method definition
def delete_directory_config(
    self,
    *,
    DirectoryName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteDirectoryConfigRequestRequestTypeDef = {  # (1)
    "DirectoryName": ...,
}

parent.delete_directory_config(**kwargs)
  1. See DeleteDirectoryConfigRequestRequestTypeDef

delete_entitlement

Deletes the specified entitlement.

Type annotations and code completion for boto3.client("appstream").delete_entitlement method. boto3 documentation

Method definition
def delete_entitlement(
    self,
    *,
    Name: str,
    StackName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteEntitlementRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "StackName": ...,
}

parent.delete_entitlement(**kwargs)
  1. See DeleteEntitlementRequestRequestTypeDef

delete_fleet

Deletes the specified fleet.

Type annotations and code completion for boto3.client("appstream").delete_fleet method. boto3 documentation

Method definition
def delete_fleet(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteFleetRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_fleet(**kwargs)
  1. See DeleteFleetRequestRequestTypeDef

delete_image

Deletes the specified image.

Type annotations and code completion for boto3.client("appstream").delete_image method. boto3 documentation

Method definition
def delete_image(
    self,
    *,
    Name: str,
) -> DeleteImageResultTypeDef:  # (1)
    ...
  1. See DeleteImageResultTypeDef
Usage example with kwargs
kwargs: DeleteImageRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_image(**kwargs)
  1. See DeleteImageRequestRequestTypeDef

delete_image_builder

Deletes the specified image builder and releases the capacity.

Type annotations and code completion for boto3.client("appstream").delete_image_builder method. boto3 documentation

Method definition
def delete_image_builder(
    self,
    *,
    Name: str,
) -> DeleteImageBuilderResultTypeDef:  # (1)
    ...
  1. See DeleteImageBuilderResultTypeDef
Usage example with kwargs
kwargs: DeleteImageBuilderRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_image_builder(**kwargs)
  1. See DeleteImageBuilderRequestRequestTypeDef

delete_image_permissions

Deletes permissions for the specified private image.

Type annotations and code completion for boto3.client("appstream").delete_image_permissions method. boto3 documentation

Method definition
def delete_image_permissions(
    self,
    *,
    Name: str,
    SharedAccountId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteImagePermissionsRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "SharedAccountId": ...,
}

parent.delete_image_permissions(**kwargs)
  1. See DeleteImagePermissionsRequestRequestTypeDef

delete_stack

Deletes the specified stack.

Type annotations and code completion for boto3.client("appstream").delete_stack method. boto3 documentation

Method definition
def delete_stack(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteStackRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_stack(**kwargs)
  1. See DeleteStackRequestRequestTypeDef

delete_usage_report_subscription

Disables usage report generation.

Type annotations and code completion for boto3.client("appstream").delete_usage_report_subscription method. boto3 documentation

Method definition
def delete_usage_report_subscription(
    self,
) -> Dict[str, Any]:
    ...

delete_user

Deletes a user from the user pool.

Type annotations and code completion for boto3.client("appstream").delete_user method. boto3 documentation

Method definition
def delete_user(
    self,
    *,
    UserName: str,
    AuthenticationType: AuthenticationTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See AuthenticationTypeType
Usage example with kwargs
kwargs: DeleteUserRequestRequestTypeDef = {  # (1)
    "UserName": ...,
    "AuthenticationType": ...,
}

parent.delete_user(**kwargs)
  1. See DeleteUserRequestRequestTypeDef

describe_app_blocks

Retrieves a list that describes one or more app blocks.

Type annotations and code completion for boto3.client("appstream").describe_app_blocks method. boto3 documentation

Method definition
def describe_app_blocks(
    self,
    *,
    Arns: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeAppBlocksResultTypeDef:  # (1)
    ...
  1. See DescribeAppBlocksResultTypeDef
Usage example with kwargs
kwargs: DescribeAppBlocksRequestRequestTypeDef = {  # (1)
    "Arns": ...,
}

parent.describe_app_blocks(**kwargs)
  1. See DescribeAppBlocksRequestRequestTypeDef

describe_application_fleet_associations

Retrieves a list that describes one or more application fleet associations.

Type annotations and code completion for boto3.client("appstream").describe_application_fleet_associations method. boto3 documentation

Method definition
def describe_application_fleet_associations(
    self,
    *,
    FleetName: str = ...,
    ApplicationArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeApplicationFleetAssociationsResultTypeDef:  # (1)
    ...
  1. See DescribeApplicationFleetAssociationsResultTypeDef
Usage example with kwargs
kwargs: DescribeApplicationFleetAssociationsRequestRequestTypeDef = {  # (1)
    "FleetName": ...,
}

parent.describe_application_fleet_associations(**kwargs)
  1. See DescribeApplicationFleetAssociationsRequestRequestTypeDef

describe_applications

Retrieves a list that describes one or more applications.

Type annotations and code completion for boto3.client("appstream").describe_applications method. boto3 documentation

Method definition
def describe_applications(
    self,
    *,
    Arns: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeApplicationsResultTypeDef:  # (1)
    ...
  1. See DescribeApplicationsResultTypeDef
Usage example with kwargs
kwargs: DescribeApplicationsRequestRequestTypeDef = {  # (1)
    "Arns": ...,
}

parent.describe_applications(**kwargs)
  1. See DescribeApplicationsRequestRequestTypeDef

describe_directory_configs

Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided.

Type annotations and code completion for boto3.client("appstream").describe_directory_configs method. boto3 documentation

Method definition
def describe_directory_configs(
    self,
    *,
    DirectoryNames: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeDirectoryConfigsResultTypeDef:  # (1)
    ...
  1. See DescribeDirectoryConfigsResultTypeDef
Usage example with kwargs
kwargs: DescribeDirectoryConfigsRequestRequestTypeDef = {  # (1)
    "DirectoryNames": ...,
}

parent.describe_directory_configs(**kwargs)
  1. See DescribeDirectoryConfigsRequestRequestTypeDef

describe_entitlements

Retrieves a list that describes one of more entitlements.

Type annotations and code completion for boto3.client("appstream").describe_entitlements method. boto3 documentation

Method definition
def describe_entitlements(
    self,
    *,
    StackName: str,
    Name: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeEntitlementsResultTypeDef:  # (1)
    ...
  1. See DescribeEntitlementsResultTypeDef
Usage example with kwargs
kwargs: DescribeEntitlementsRequestRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.describe_entitlements(**kwargs)
  1. See DescribeEntitlementsRequestRequestTypeDef

describe_fleets

Retrieves a list that describes one or more specified fleets, if the fleet names are provided.

Type annotations and code completion for boto3.client("appstream").describe_fleets method. boto3 documentation

Method definition
def describe_fleets(
    self,
    *,
    Names: Sequence[str] = ...,
    NextToken: str = ...,
) -> DescribeFleetsResultTypeDef:  # (1)
    ...
  1. See DescribeFleetsResultTypeDef
Usage example with kwargs
kwargs: DescribeFleetsRequestRequestTypeDef = {  # (1)
    "Names": ...,
}

parent.describe_fleets(**kwargs)
  1. See DescribeFleetsRequestRequestTypeDef

describe_image_builders

Retrieves a list that describes one or more specified image builders, if the image builder names are provided.

Type annotations and code completion for boto3.client("appstream").describe_image_builders method. boto3 documentation

Method definition
def describe_image_builders(
    self,
    *,
    Names: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeImageBuildersResultTypeDef:  # (1)
    ...
  1. See DescribeImageBuildersResultTypeDef
Usage example with kwargs
kwargs: DescribeImageBuildersRequestRequestTypeDef = {  # (1)
    "Names": ...,
}

parent.describe_image_builders(**kwargs)
  1. See DescribeImageBuildersRequestRequestTypeDef

describe_image_permissions

Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.

Type annotations and code completion for boto3.client("appstream").describe_image_permissions method. boto3 documentation

Method definition
def describe_image_permissions(
    self,
    *,
    Name: str,
    MaxResults: int = ...,
    SharedAwsAccountIds: Sequence[str] = ...,
    NextToken: str = ...,
) -> DescribeImagePermissionsResultTypeDef:  # (1)
    ...
  1. See DescribeImagePermissionsResultTypeDef
Usage example with kwargs
kwargs: DescribeImagePermissionsRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_image_permissions(**kwargs)
  1. See DescribeImagePermissionsRequestRequestTypeDef

describe_images

Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.

Type annotations and code completion for boto3.client("appstream").describe_images method. boto3 documentation

Method definition
def describe_images(
    self,
    *,
    Names: Sequence[str] = ...,
    Arns: Sequence[str] = ...,
    Type: VisibilityTypeType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeImagesResultTypeDef:  # (2)
    ...
  1. See VisibilityTypeType
  2. See DescribeImagesResultTypeDef
Usage example with kwargs
kwargs: DescribeImagesRequestRequestTypeDef = {  # (1)
    "Names": ...,
}

parent.describe_images(**kwargs)
  1. See DescribeImagesRequestRequestTypeDef

describe_sessions

Retrieves a list that describes the streaming sessions for a specified stack and fleet.

Type annotations and code completion for boto3.client("appstream").describe_sessions method. boto3 documentation

Method definition
def describe_sessions(
    self,
    *,
    StackName: str,
    FleetName: str,
    UserId: str = ...,
    NextToken: str = ...,
    Limit: int = ...,
    AuthenticationType: AuthenticationTypeType = ...,  # (1)
) -> DescribeSessionsResultTypeDef:  # (2)
    ...
  1. See AuthenticationTypeType
  2. See DescribeSessionsResultTypeDef
Usage example with kwargs
kwargs: DescribeSessionsRequestRequestTypeDef = {  # (1)
    "StackName": ...,
    "FleetName": ...,
}

parent.describe_sessions(**kwargs)
  1. See DescribeSessionsRequestRequestTypeDef

describe_stacks

Retrieves a list that describes one or more specified stacks, if the stack names are provided.

Type annotations and code completion for boto3.client("appstream").describe_stacks method. boto3 documentation

Method definition
def describe_stacks(
    self,
    *,
    Names: Sequence[str] = ...,
    NextToken: str = ...,
) -> DescribeStacksResultTypeDef:  # (1)
    ...
  1. See DescribeStacksResultTypeDef
Usage example with kwargs
kwargs: DescribeStacksRequestRequestTypeDef = {  # (1)
    "Names": ...,
}

parent.describe_stacks(**kwargs)
  1. See DescribeStacksRequestRequestTypeDef

describe_usage_report_subscriptions

Retrieves a list that describes one or more usage report subscriptions.

Type annotations and code completion for boto3.client("appstream").describe_usage_report_subscriptions method. boto3 documentation

Method definition
def describe_usage_report_subscriptions(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeUsageReportSubscriptionsResultTypeDef:  # (1)
    ...
  1. See DescribeUsageReportSubscriptionsResultTypeDef
Usage example with kwargs
kwargs: DescribeUsageReportSubscriptionsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.describe_usage_report_subscriptions(**kwargs)
  1. See DescribeUsageReportSubscriptionsRequestRequestTypeDef

describe_user_stack_associations

Retrieves a list that describes the UserStackAssociation objects.

Type annotations and code completion for boto3.client("appstream").describe_user_stack_associations method. boto3 documentation

Method definition
def describe_user_stack_associations(
    self,
    *,
    StackName: str = ...,
    UserName: str = ...,
    AuthenticationType: AuthenticationTypeType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeUserStackAssociationsResultTypeDef:  # (2)
    ...
  1. See AuthenticationTypeType
  2. See DescribeUserStackAssociationsResultTypeDef
Usage example with kwargs
kwargs: DescribeUserStackAssociationsRequestRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.describe_user_stack_associations(**kwargs)
  1. See DescribeUserStackAssociationsRequestRequestTypeDef

describe_users

Retrieves a list that describes one or more specified users in the user pool.

Type annotations and code completion for boto3.client("appstream").describe_users method. boto3 documentation

Method definition
def describe_users(
    self,
    *,
    AuthenticationType: AuthenticationTypeType,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeUsersResultTypeDef:  # (2)
    ...
  1. See AuthenticationTypeType
  2. See DescribeUsersResultTypeDef
Usage example with kwargs
kwargs: DescribeUsersRequestRequestTypeDef = {  # (1)
    "AuthenticationType": ...,
}

parent.describe_users(**kwargs)
  1. See DescribeUsersRequestRequestTypeDef

disable_user

Disables the specified user in the user pool.

Type annotations and code completion for boto3.client("appstream").disable_user method. boto3 documentation

Method definition
def disable_user(
    self,
    *,
    UserName: str,
    AuthenticationType: AuthenticationTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See AuthenticationTypeType
Usage example with kwargs
kwargs: DisableUserRequestRequestTypeDef = {  # (1)
    "UserName": ...,
    "AuthenticationType": ...,
}

parent.disable_user(**kwargs)
  1. See DisableUserRequestRequestTypeDef

disassociate_application_fleet

Disassociates the specified application from the fleet.

Type annotations and code completion for boto3.client("appstream").disassociate_application_fleet method. boto3 documentation

Method definition
def disassociate_application_fleet(
    self,
    *,
    FleetName: str,
    ApplicationArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateApplicationFleetRequestRequestTypeDef = {  # (1)
    "FleetName": ...,
    "ApplicationArn": ...,
}

parent.disassociate_application_fleet(**kwargs)
  1. See DisassociateApplicationFleetRequestRequestTypeDef

disassociate_application_from_entitlement

Deletes the specified application from the specified entitlement.

Type annotations and code completion for boto3.client("appstream").disassociate_application_from_entitlement method. boto3 documentation

Method definition
def disassociate_application_from_entitlement(
    self,
    *,
    StackName: str,
    EntitlementName: str,
    ApplicationIdentifier: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateApplicationFromEntitlementRequestRequestTypeDef = {  # (1)
    "StackName": ...,
    "EntitlementName": ...,
    "ApplicationIdentifier": ...,
}

parent.disassociate_application_from_entitlement(**kwargs)
  1. See DisassociateApplicationFromEntitlementRequestRequestTypeDef

disassociate_fleet

Disassociates the specified fleet from the specified stack.

Type annotations and code completion for boto3.client("appstream").disassociate_fleet method. boto3 documentation

Method definition
def disassociate_fleet(
    self,
    *,
    FleetName: str,
    StackName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateFleetRequestRequestTypeDef = {  # (1)
    "FleetName": ...,
    "StackName": ...,
}

parent.disassociate_fleet(**kwargs)
  1. See DisassociateFleetRequestRequestTypeDef

enable_user

Enables a user in the user pool.

Type annotations and code completion for boto3.client("appstream").enable_user method. boto3 documentation

Method definition
def enable_user(
    self,
    *,
    UserName: str,
    AuthenticationType: AuthenticationTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See AuthenticationTypeType
Usage example with kwargs
kwargs: EnableUserRequestRequestTypeDef = {  # (1)
    "UserName": ...,
    "AuthenticationType": ...,
}

parent.enable_user(**kwargs)
  1. See EnableUserRequestRequestTypeDef

expire_session

Immediately stops the specified streaming session.

Type annotations and code completion for boto3.client("appstream").expire_session method. boto3 documentation

Method definition
def expire_session(
    self,
    *,
    SessionId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: ExpireSessionRequestRequestTypeDef = {  # (1)
    "SessionId": ...,
}

parent.expire_session(**kwargs)
  1. See ExpireSessionRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("appstream").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_associated_fleets

Retrieves the name of the fleet that is associated with the specified stack.

Type annotations and code completion for boto3.client("appstream").list_associated_fleets method. boto3 documentation

Method definition
def list_associated_fleets(
    self,
    *,
    StackName: str,
    NextToken