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

# AppStreamClient 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.

# Exceptions.exceptions usage example

client = boto3.client("appstream")

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

from mypy_boto3_appstream.client import Exceptions

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

Methods#

can_paginate#

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

# can_paginate method definition

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

generate_presigned_url#

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

# generate_presigned_url method definition

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

associate_app_block_builder_app_block#

Associates the specified app block builder with the specified app block.

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

# associate_app_block_builder_app_block method definition

def associate_app_block_builder_app_block(
    self,
    *,
    AppBlockArn: str,
    AppBlockBuilderName: str,
) -> AssociateAppBlockBuilderAppBlockResultTypeDef:  # (1)
    ...
  1. See AssociateAppBlockBuilderAppBlockResultTypeDef 
# associate_app_block_builder_app_block method usage example with argument unpacking

kwargs: AssociateAppBlockBuilderAppBlockRequestRequestTypeDef = {  # (1)
    "AppBlockArn": ...,
    "AppBlockBuilderName": ...,
}

parent.associate_app_block_builder_app_block(**kwargs)
  1. See AssociateAppBlockBuilderAppBlockRequestRequestTypeDef

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

# associate_application_fleet method definition

def associate_application_fleet(
    self,
    *,
    FleetName: str,
    ApplicationArn: str,
) -> AssociateApplicationFleetResultTypeDef:  # (1)
    ...
  1. See AssociateApplicationFleetResultTypeDef 
# associate_application_fleet method usage example with argument unpacking

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

# associate_application_to_entitlement method definition

def associate_application_to_entitlement(
    self,
    *,
    StackName: str,
    EntitlementName: str,
    ApplicationIdentifier: str,
) -> dict[str, Any]:
    ...
# associate_application_to_entitlement method usage example with argument unpacking

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

# associate_fleet method definition

def associate_fleet(
    self,
    *,
    FleetName: str,
    StackName: str,
) -> dict[str, Any]:
    ...
# associate_fleet method usage example with argument unpacking

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

# batch_associate_user_stack method definition

def batch_associate_user_stack(
    self,
    *,
    UserStackAssociations: Sequence[UserStackAssociationTypeDef],  # (1)
) -> BatchAssociateUserStackResultTypeDef:  # (2)
    ...
  1. See UserStackAssociationTypeDef
  2. See BatchAssociateUserStackResultTypeDef 
# batch_associate_user_stack method usage example with argument unpacking

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

# batch_disassociate_user_stack method definition

def batch_disassociate_user_stack(
    self,
    *,
    UserStackAssociations: Sequence[UserStackAssociationTypeDef],  # (1)
) -> BatchDisassociateUserStackResultTypeDef:  # (2)
    ...
  1. See UserStackAssociationTypeDef
  2. See BatchDisassociateUserStackResultTypeDef 
# batch_disassociate_user_stack method usage example with argument unpacking

kwargs: BatchDisassociateUserStackRequestRequestTypeDef = {  # (1)
    "UserStackAssociations": ...,
}

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

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

# copy_image method definition

def copy_image(
    self,
    *,
    SourceImageName: str,
    DestinationImageName: str,
    DestinationRegion: str,
    DestinationImageDescription: str = ...,
) -> CopyImageResponseTypeDef:  # (1)
    ...
  1. See CopyImageResponseTypeDef 
# copy_image method usage example with argument unpacking

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

# create_app_block method definition

def create_app_block(
    self,
    *,
    Name: str,
    SourceS3Location: S3LocationTypeDef,  # (1)
    Description: str = ...,
    DisplayName: str = ...,
    SetupScriptDetails: ScriptDetailsTypeDef = ...,  # (2)
    Tags: Mapping[str, str] = ...,
    PostSetupScriptDetails: ScriptDetailsTypeDef = ...,  # (2)
    PackagingType: PackagingTypeType = ...,  # (4)
) -> CreateAppBlockResultTypeDef:  # (5)
    ...
  1. See S3LocationTypeDef
  2. See ScriptDetailsTypeDef
  3. See ScriptDetailsTypeDef
  4. See PackagingTypeType
  5. See CreateAppBlockResultTypeDef 
# create_app_block method usage example with argument unpacking

kwargs: CreateAppBlockRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "SourceS3Location": ...,
}

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

create_app_block_builder#

Creates an app block builder.

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

# create_app_block_builder method definition

def create_app_block_builder(
    self,
    *,
    Name: str,
    Platform: AppBlockBuilderPlatformTypeType,  # (1)
    InstanceType: str,
    VpcConfig: VpcConfigTypeDef,  # (2)
    Description: str = ...,
    DisplayName: str = ...,
    Tags: Mapping[str, str] = ...,
    EnableDefaultInternetAccess: bool = ...,
    IamRoleArn: str = ...,
    AccessEndpoints: Sequence[AccessEndpointTypeDef] = ...,  # (3)
) -> CreateAppBlockBuilderResultTypeDef:  # (4)
    ...
  1. See AppBlockBuilderPlatformTypeType
  2. See VpcConfigTypeDef
  3. See AccessEndpointTypeDef
  4. See CreateAppBlockBuilderResultTypeDef 
# create_app_block_builder method usage example with argument unpacking

kwargs: CreateAppBlockBuilderRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Platform": ...,
    "InstanceType": ...,
    "VpcConfig": ...,
}

parent.create_app_block_builder(**kwargs)
  1. See CreateAppBlockBuilderRequestRequestTypeDef

create_app_block_builder_streaming_url#

Creates a URL to start a create app block builder streaming session.

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

# create_app_block_builder_streaming_url method definition

def create_app_block_builder_streaming_url(
    self,
    *,
    AppBlockBuilderName: str,
    Validity: int = ...,
) -> CreateAppBlockBuilderStreamingURLResultTypeDef:  # (1)
    ...
  1. See CreateAppBlockBuilderStreamingURLResultTypeDef 
# create_app_block_builder_streaming_url method usage example with argument unpacking

kwargs: CreateAppBlockBuilderStreamingURLRequestRequestTypeDef = {  # (1)
    "AppBlockBuilderName": ...,
}

parent.create_app_block_builder_streaming_url(**kwargs)
  1. See CreateAppBlockBuilderStreamingURLRequestRequestTypeDef

create_application#

Creates an application.

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

# create_application 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 
# create_application method usage example with argument unpacking

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

# create_directory_config method definition

def create_directory_config(
    self,
    *,
    DirectoryName: str,
    OrganizationalUnitDistinguishedNames: Sequence[str],
    ServiceAccountCredentials: ServiceAccountCredentialsTypeDef = ...,  # (1)
    CertificateBasedAuthProperties: CertificateBasedAuthPropertiesTypeDef = ...,  # (2)
) -> CreateDirectoryConfigResultTypeDef:  # (3)
    ...
  1. See ServiceAccountCredentialsTypeDef
  2. See CertificateBasedAuthPropertiesTypeDef
  3. See CreateDirectoryConfigResultTypeDef 
# create_directory_config method usage example with argument unpacking

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

# create_entitlement 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 
# create_entitlement method usage example with argument unpacking

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

# create_fleet 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)
    MaxSessionsPerInstance: int = ...,
) -> 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 
# create_fleet method usage example with argument unpacking

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

# create_image_builder 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 
# create_image_builder method usage example with argument unpacking

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

# create_image_builder_streaming_url method definition

def create_image_builder_streaming_url(
    self,
    *,
    Name: str,
    Validity: int = ...,
) -> CreateImageBuilderStreamingURLResultTypeDef:  # (1)
    ...
  1. See CreateImageBuilderStreamingURLResultTypeDef 
# create_image_builder_streaming_url method usage example with argument unpacking

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

# create_stack method definition

def create_stack(
    self,
    *,
    Name: str,
    Description: str = ...,
    DisplayName: str = ...,
    StorageConnectors: Sequence[StorageConnectorUnionTypeDef] = ...,  # (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 StorageConnectorOutputTypeDef
  2. See UserSettingTypeDef
  3. See ApplicationSettingsTypeDef
  4. See AccessEndpointTypeDef
  5. See StreamingExperienceSettingsTypeDef
  6. See CreateStackResultTypeDef 
# create_stack method usage example with argument unpacking

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

# create_streaming_url method definition

def create_streaming_url(
    self,
    *,
    StackName: str,
    FleetName: str,
    UserId: str,
    ApplicationId: str = ...,
    Validity: int = ...,
    SessionContext: str = ...,
) -> CreateStreamingURLResultTypeDef:  # (1)
    ...
  1. See CreateStreamingURLResultTypeDef 
# create_streaming_url method usage example with argument unpacking

kwargs: CreateStreamingURLRequestRequestTypeDef = {  # (1)
    "StackName": ...,
    "FleetName": ...,
    "UserId": ...,
}

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

create_theme_for_stack#

Creates custom branding that customizes the appearance of the streaming application catalog page.

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

# create_theme_for_stack method definition

def create_theme_for_stack(
    self,
    *,
    StackName: str,
    TitleText: str,
    ThemeStyling: ThemeStylingType,  # (1)
    OrganizationLogoS3Location: S3LocationTypeDef,  # (2)
    FaviconS3Location: S3LocationTypeDef,  # (2)
    FooterLinks: Sequence[ThemeFooterLinkTypeDef] = ...,  # (4)
) -> CreateThemeForStackResultTypeDef:  # (5)
    ...
  1. See ThemeStylingType
  2. See S3LocationTypeDef
  3. See S3LocationTypeDef
  4. See ThemeFooterLinkTypeDef
  5. See CreateThemeForStackResultTypeDef 
# create_theme_for_stack method usage example with argument unpacking

kwargs: CreateThemeForStackRequestRequestTypeDef = {  # (1)
    "StackName": ...,
    "TitleText": ...,
    "ThemeStyling": ...,
    "OrganizationLogoS3Location": ...,
    "FaviconS3Location": ...,
}

parent.create_theme_for_stack(**kwargs)
  1. See CreateThemeForStackRequestRequestTypeDef

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

# create_updated_image 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 
# create_updated_image method usage example with argument unpacking

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

# create_usage_report_subscription 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

# create_user 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 
# create_user method usage example with argument unpacking

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

# delete_app_block method definition

def delete_app_block(
    self,
    *,
    Name: str,
) -> dict[str, Any]:
    ...
# delete_app_block method usage example with argument unpacking

kwargs: DeleteAppBlockRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

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

delete_app_block_builder#

Deletes an app block builder.

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

# delete_app_block_builder method definition

def delete_app_block_builder(
    self,
    *,
    Name: str,
) -> dict[str, Any]:
    ...
# delete_app_block_builder method usage example with argument unpacking

kwargs: DeleteAppBlockBuilderRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_app_block_builder(**kwargs)
  1. See DeleteAppBlockBuilderRequestRequestTypeDef

delete_application#

Deletes an application.

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

# delete_application method definition

def delete_application(
    self,
    *,
    Name: str,
) -> dict[str, Any]:
    ...
# delete_application method usage example with argument unpacking

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

# delete_directory_config method definition

def delete_directory_config(
    self,
    *,
    DirectoryName: str,
) -> dict[str, Any]:
    ...
# delete_directory_config method usage example with argument unpacking

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

# delete_entitlement method definition

def delete_entitlement(
    self,
    *,
    Name: str,
    StackName: str,
) -> dict[str, Any]:
    ...
# delete_entitlement method usage example with argument unpacking

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

# delete_fleet method definition

def delete_fleet(
    self,
    *,
    Name: str,
) -> dict[str, Any]:
    ...
# delete_fleet method usage example with argument unpacking

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

# delete_image method definition

def delete_image(
    self,
    *,
    Name: str,
) -> DeleteImageResultTypeDef:  # (1)
    ...
  1. See DeleteImageResultTypeDef 
# delete_image method usage example with argument unpacking

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

# delete_image_builder method definition

def delete_image_builder(
    self,
    *,
    Name: str,
) -> DeleteImageBuilderResultTypeDef:  # (1)
    ...
  1. See DeleteImageBuilderResultTypeDef 
# delete_image_builder method usage example with argument unpacking

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

# delete_image_permissions method definition

def delete_image_permissions(
    self,
    *,
    Name: str,
    SharedAccountId: str,
) -> dict[str, Any]:
    ...
# delete_image_permissions method usage example with argument unpacking

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

# delete_stack method definition

def delete_stack(
    self,
    *,
    Name: str,
) -> dict[str, Any]:
    ...
# delete_stack method usage example with argument unpacking

kwargs: DeleteStackRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

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

delete_theme_for_stack#

Deletes custom branding that customizes the appearance of the streaming application catalog page.

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

# delete_theme_for_stack method definition

def delete_theme_for_stack(
    self,
    *,
    StackName: str,
) -> dict[str, Any]:
    ...
# delete_theme_for_stack method usage example with argument unpacking

kwargs: DeleteThemeForStackRequestRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.delete_theme_for_stack(**kwargs)
  1. See DeleteThemeForStackRequestRequestTypeDef

delete_usage_report_subscription#

Disables usage report generation.

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

# delete_usage_report_subscription 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

# delete_user method definition

def delete_user(
    self,
    *,
    UserName: str,
    AuthenticationType: AuthenticationTypeType,  # (1)
) -> dict[str, Any]:
    ...
  1. See AuthenticationTypeType 
# delete_user method usage example with argument unpacking

kwargs: DeleteUserRequestRequestTypeDef = {  # (1)
    "UserName": ...,
    "AuthenticationType": ...,
}

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

describe_app_block_builder_app_block_associations#

Retrieves a list that describes one or more app block builder associations.

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

# describe_app_block_builder_app_block_associations method definition

def describe_app_block_builder_app_block_associations(
    self,
    *,
    AppBlockArn: str = ...,
    AppBlockBuilderName: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeAppBlockBuilderAppBlockAssociationsResultTypeDef:  # (1)
    ...
  1. See DescribeAppBlockBuilderAppBlockAssociationsResultTypeDef 
# describe_app_block_builder_app_block_associations method usage example with argument unpacking

kwargs: DescribeAppBlockBuilderAppBlockAssociationsRequestRequestTypeDef = {  # (1)
    "AppBlockArn": ...,
}

parent.describe_app_block_builder_app_block_associations(**kwargs)
  1. See DescribeAppBlockBuilderAppBlockAssociationsRequestRequestTypeDef

describe_app_block_builders#

Retrieves a list that describes one or more app block builders.

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

# describe_app_block_builders method definition

def describe_app_block_builders(
    self,
    *,
    Names: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeAppBlockBuildersResultTypeDef:  # (1)
    ...
  1. See DescribeAppBlockBuildersResultTypeDef 
# describe_app_block_builders method usage example with argument unpacking

kwargs: DescribeAppBlockBuildersRequestRequestTypeDef = {  # (1)
    "Names": ...,
}

parent.describe_app_block_builders(**kwargs)
  1. See DescribeAppBlockBuildersRequestRequestTypeDef

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

# describe_app_blocks method definition

def describe_app_blocks(
    self,
    *,
    Arns: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeAppBlocksResultTypeDef:  # (1)
    ...
  1. See DescribeAppBlocksResultTypeDef 
# describe_app_blocks method usage example with argument unpacking

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

# describe_application_fleet_associations method definition

def describe_application_fleet_associations(
    self,
    *,
    FleetName: str = ...,
    ApplicationArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeApplicationFleetAssociationsResultTypeDef:  # (1)
    ...
  1. See DescribeApplicationFleetAssociationsResultTypeDef 
# describe_application_fleet_associations method usage example with argument unpacking

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

# describe_applications method definition

def describe_applications(
    self,
    *,
    Arns: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeApplicationsResultTypeDef:  # (1)
    ...
  1. See DescribeApplicationsResultTypeDef 
# describe_applications method usage example with argument unpacking

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

# describe_directory_configs method definition

def describe_directory_configs(
    self,
    *,
    DirectoryNames: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeDirectoryConfigsResultTypeDef:  # (1)
    ...
  1. See DescribeDirectoryConfigsResultTypeDef 
# describe_directory_configs method usage example with argument unpacking

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

# describe_entitlements method definition

def describe_entitlements(
    self,
    *,
    StackName: str,
    Name: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeEntitlementsResultTypeDef:  # (1)
    ...
  1. See DescribeEntitlementsResultTypeDef 
# describe_entitlements method usage example with argument unpacking

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

# describe_fleets method definition

def describe_fleets(
    self,
    *,
    Names: Sequence[str] = ...,
    NextToken: str = ...,
) -> DescribeFleetsResultTypeDef:  # (1)
    ...
  1. See DescribeFleetsResultTypeDef 
# describe_fleets method usage example with argument unpacking

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

# describe_image_builders method definition

def describe_image_builders(
    self,
    *,
    Names: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeImageBuildersResultTypeDef:  # (1)
    ...
  1. See DescribeImageBuildersResultTypeDef 
# describe_image_builders method usage example with argument unpacking

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

# describe_image_permissions method definition

def describe_image_permissions(
    self,
    *,
    Name: str,
    MaxResults: int = ...,
    SharedAwsAccountIds: Sequence[str] = ...,
    NextToken: str = ...,
) -> DescribeImagePermissionsResultTypeDef:  # (1)
    ...
  1. See DescribeImagePermissionsResultTypeDef 
# describe_image_permissions method usage example with argument unpacking

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

# describe_images 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 
# describe_images method usage example with argument unpacking

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

# describe_sessions method definition

def describe_sessions(
    self,
    *,
    StackName: str,
    FleetName: str,
    UserId: str = ...,
    NextToken: str = ...,
    Limit: int = ...,
    AuthenticationType: AuthenticationTypeType = ...,  # (1)
    InstanceId: str = ...,
) -> DescribeSessionsResultTypeDef:  # (2)
    ...
  1. See AuthenticationTypeType
  2. See DescribeSessionsResultTypeDef 
# describe_sessions method usage example with argument unpacking

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

# describe_stacks method definition

def describe_stacks(
    self,
    *,
    Names: Sequence[str] = ...,
    NextToken: str = ...,
) -> DescribeStacksResultTypeDef:  # (1)
    ...
  1. See DescribeStacksResultTypeDef 
# describe_stacks method usage example with argument unpacking

kwargs: DescribeStacksRequestRequestTypeDef = {  # (1)
    "Names": ...,
}

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

describe_theme_for_stack#

Retrieves a list that describes the theme for a specified stack.

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

# describe_theme_for_stack method definition

def describe_theme_for_stack(
    self,
    *,
    StackName: str,
) -> DescribeThemeForStackResultTypeDef:  # (1)
    ...
  1. See DescribeThemeForStackResultTypeDef 
# describe_theme_for_stack method usage example with argument unpacking

kwargs: DescribeThemeForStackRequestRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.describe_theme_for_stack(**kwargs)
  1. See DescribeThemeForStackRequestRequestTypeDef

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

# describe_usage_report_subscriptions method definition

def describe_usage_report_subscriptions(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeUsageReportSubscriptionsResultTypeDef:  # (1)
    ...
  1. See DescribeUsageReportSubscriptionsResultTypeDef 
# describe_usage_report_subscriptions method usage example with argument unpacking

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

# describe_user_stack_associations 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 
# describe_user_stack_associations method usage example with argument unpacking

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

# describe_users method definition

def describe_users(
    self,
    *,
    AuthenticationType: AuthenticationTypeType,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeUsersResultTypeDef:  # (2)
    ...
  1. See AuthenticationTypeType
  2. See DescribeUsersResultTypeDef 
# describe_users method usage example with argument unpacking

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

# disable_user method definition

def disable_user(
    self,
    *,
    UserName: str,
    AuthenticationType: AuthenticationTypeType,  # (1)
) -> dict[str, Any]:
    ...
  1. See AuthenticationTypeType 
# disable_user method usage example with argument unpacking

kwargs: DisableUserRequestRequestTypeDef = {  # (1)
    "UserName": ...,
    "AuthenticationType": ...,
}

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

disassociate_app_block_builder_app_block#

Disassociates a specified app block builder from a specified app block.

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

# disassociate_app_block_builder_app_block method definition

def disassociate_app_block_builder_app_block(
    self,
    *,
    AppBlockArn: str,
    AppBlockBuilderName: str,
) -> dict[str, Any]:
    ...
# disassociate_app_block_builder_app_block method usage example with argument unpacking

kwargs: DisassociateAppBlockBuilderAppBlockRequestRequestTypeDef = {  # (1)
    "AppBlockArn": ...,
    "AppBlockBuilderName": ...,
}

parent.disassociate_app_block_builder_app_block(**kwargs)
  1. See DisassociateAppBlockBuilderAppBlockRequestRequestTypeDef

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

# disassociate_application_fleet method definition

def disassociate_application_fleet(
    self,
    *,
    FleetName: str,
    ApplicationArn: str,
) -> dict[str, Any]:
    ...
# disassociate_application_fleet method usage example with argument unpacking

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

# disassociate_application_from_entitlement method definition

def disassociate_application_from_entitlement(
    self,
    *,
    StackName: str,
    EntitlementName: str,
    ApplicationIdentifier: str,
) -> dict[str, Any]:
    ...
# disassociate_application_from_entitlement method usage example with argument unpacking

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

# disassociate_fleet method definition

def disassociate_fleet(
    self,
    *,
    FleetName: str,
    StackName: str,
) -> dict[str, Any]:
    ...
# disassociate_fleet method usage example with argument unpacking

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

# enable_user method definition

def enable_user(
    self,
    *,
    UserName: str,
    AuthenticationType: AuthenticationTypeType,  # (1)
) -> dict[str, Any]:
    ...
  1. See AuthenticationTypeType 
# enable_user method usage example with argument unpacking

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

# expire_session method definition

def expire_session(
    self,
    *,
    SessionId: str,
) -> dict[str, Any]:
    ...
# expire_session method usage example with argument unpacking

kwargs: ExpireSessionRequestRequestTypeDef = {  # (1)
    "SessionId": ...,
}

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

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

# list_associated_fleets method definition

def list_associated_fleets(
    self,
    *,
    StackName: str,
    NextToken: str = ...,
) -> ListAssociatedFleetsResultTypeDef:  # (1)
    ...
  1. See ListAssociatedFleetsResultTypeDef 
# list_associated_fleets method usage example with argument unpacking

kwargs: ListAssociatedFleetsRequestRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.list_associated_fleets(**kwargs)
  1. See ListAssociatedFleetsRequestRequestTypeDef

list_associated_stacks#

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

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

# list_associated_stacks method definition

def list_associated_stacks(
    self,
    *,
    FleetName: str,
    NextToken: str = ...,
) -> ListAssociatedStacksResultTypeDef:  # (1)
    ...
  1. See ListAssociatedStacksResultTypeDef 
# list_associated_stacks method usage example with argument unpacking

kwargs: ListAssociatedStacksRequestRequestTypeDef = {  # (1)
    "FleetName": ...,
}

parent.list_associated_stacks(**kwargs)
  1. See ListAssociatedStacksRequestRequestTypeDef

list_entitled_applications#

Retrieves a list of entitled applications.

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

# list_entitled_applications method definition

def list_entitled_applications(
    self,
    *,
    StackName: str,
    EntitlementName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEntitledApplicationsResultTypeDef:  # (1)
    ...
  1. See ListEntitledApplicationsResultTypeDef 
# list_entitled_applications method usage example with argument unpacking

kwargs: ListEntitledApplicationsRequestRequestTypeDef = {  # (1)
    "StackName": ...,
    "EntitlementName": ...,
}

parent.list_entitled_applications(**kwargs)
  1. See ListEntitledApplicationsRequestRequestTypeDef

list_tags_for_resource#

Retrieves a list of all tags for the specified AppStream 2.0 resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

start_app_block_builder#

Starts an app block builder.

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

# start_app_block_builder method definition

def start_app_block_builder(
    self,
    *,
    Name: str,
) -> StartAppBlockBuilderResultTypeDef:  # (1)
    ...
  1. See StartAppBlockBuilderResultTypeDef 
# start_app_block_builder method usage example with argument unpacking

kwargs: StartAppBlockBuilderRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.start_app_block_builder(**kwargs)
  1. See StartAppBlockBuilderRequestRequestTypeDef

start_fleet#

Starts the specified fleet.

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

# start_fleet method definition

def start_fleet(
    self,
    *,
    Name: str,
) -> dict[str, Any]:
    ...
# start_fleet method usage example with argument unpacking

kwargs: StartFleetRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.start_fleet(**kwargs)
  1. See StartFleetRequestRequestTypeDef

start_image_builder#

Starts the specified image builder.

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

# start_image_builder method definition

def start_image_builder(
    self,
    *,
    Name: str,
    AppstreamAgentVersion: str = ...,
) -> StartImageBuilderResultTypeDef:  # (1)
    ...
  1. See StartImageBuilderResultTypeDef 
# start_image_builder method usage example with argument unpacking

kwargs: StartImageBuilderRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.start_image_builder(**kwargs)
  1. See StartImageBuilderRequestRequestTypeDef

stop_app_block_builder#

Stops an app block builder.

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

# stop_app_block_builder method definition

def stop_app_block_builder(
    self,
    *,
    Name: str,
) -> StopAppBlockBuilderResultTypeDef:  # (1)
    ...
  1. See StopAppBlockBuilderResultTypeDef 
# stop_app_block_builder method usage example with argument unpacking

kwargs: StopAppBlockBuilderRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.stop_app_block_builder(**kwargs)
  1. See StopAppBlockBuilderRequestRequestTypeDef

stop_fleet#

Stops the specified fleet.

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

# stop_fleet method definition

def stop_fleet(
    self,
    *,
    Name: str,
) -> dict[str, Any]:
    ...
# stop_fleet method usage example with argument unpacking

kwargs: StopFleetRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.stop_fleet(**kwargs)
  1. See StopFleetRequestRequestTypeDef

stop_image_builder#

Stops the specified image builder.

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

# stop_image_builder method definition

def stop_image_builder(
    self,
    *,
    Name: str,
) -> StopImageBuilderResultTypeDef:  # (1)
    ...
  1. See StopImageBuilderResultTypeDef 
# stop_image_builder method usage example with argument unpacking

kwargs: StopImageBuilderRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.stop_image_builder(**kwargs)
  1. See StopImageBuilderRequestRequestTypeDef

tag_resource#

Adds or overwrites one or more tags for the specified AppStream 2.0 resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Disassociates one or more specified tags from the specified AppStream 2.0 resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_app_block_builder#

Updates an app block builder.

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

# update_app_block_builder method definition

def update_app_block_builder(
    self,
    *,
    Name: str,
    Description: str = ...,
    DisplayName: str = ...,
    Platform: PlatformTypeType = ...,  # (1)
    InstanceType: str = ...,
    VpcConfig: VpcConfigTypeDef = ...,  # (2)
    EnableDefaultInternetAccess: bool = ...,
    IamRoleArn: str = ...,
    AccessEndpoints: Sequence[AccessEndpointTypeDef] = ...,  # (3)
    AttributesToDelete: Sequence[AppBlockBuilderAttributeType] = ...,  # (4)
) -> UpdateAppBlockBuilderResultTypeDef:  # (5)
    ...
  1. See PlatformTypeType
  2. See VpcConfigTypeDef
  3. See AccessEndpointTypeDef
  4. See AppBlockBuilderAttributeType
  5. See UpdateAppBlockBuilderResultTypeDef 
# update_app_block_builder method usage example with argument unpacking

kwargs: UpdateAppBlockBuilderRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.update_app_block_builder(**kwargs)
  1. See UpdateAppBlockBuilderRequestRequestTypeDef

update_application#

Updates the specified application.

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

# update_application method definition

def update_application(
    self,
    *,
    Name: str,
    DisplayName: str = ...,
    Description: str = ...,
    IconS3Location: S3LocationTypeDef = ...,  # (1)
    LaunchPath: str = ...,
    WorkingDirectory: str = ...,
    LaunchParameters: str = ...,
    AppBlockArn: str = ...,
    AttributesToDelete: Sequence[ApplicationAttributeType] = ...,  # (2)
) -> UpdateApplicationResultTypeDef:  # (3)
    ...
  1. See S3LocationTypeDef
  2. See ApplicationAttributeType
  3. See UpdateApplicationResultTypeDef 
# update_application method usage example with argument unpacking

kwargs: UpdateApplicationRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.update_application(**kwargs)
  1. See UpdateApplicationRequestRequestTypeDef

update_directory_config#

Updates the specified Directory Config object in AppStream 2.0.

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

# update_directory_config method definition

def update_directory_config(
    self,
    *,
    DirectoryName: str,
    OrganizationalUnitDistinguishedNames: Sequence[str] = ...,
    ServiceAccountCredentials: ServiceAccountCredentialsTypeDef = ...,  # (1)
    CertificateBasedAuthProperties: CertificateBasedAuthPropertiesTypeDef = ...,  # (2)
) -> UpdateDirectoryConfigResultTypeDef:  # (3)
    ...
  1. See ServiceAccountCredentialsTypeDef
  2. See CertificateBasedAuthPropertiesTypeDef
  3. See UpdateDirectoryConfigResultTypeDef 
# update_directory_config method usage example with argument unpacking

kwargs: UpdateDirectoryConfigRequestRequestTypeDef = {  # (1)
    "DirectoryName": ...,
}

parent.update_directory_config(**kwargs)
  1. See UpdateDirectoryConfigRequestRequestTypeDef

update_entitlement#

Updates the specified entitlement.

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

# update_entitlement method definition

def update_entitlement(
    self,
    *,
    Name: str,
    StackName: str,
    Description: str = ...,
    AppVisibility: AppVisibilityType = ...,  # (1)
    Attributes: Sequence[EntitlementAttributeTypeDef] = ...,  # (2)
) -> UpdateEntitlementResultTypeDef:  # (3)
    ...
  1. See AppVisibilityType
  2. See EntitlementAttributeTypeDef
  3. See UpdateEntitlementResultTypeDef 
# update_entitlement method usage example with argument unpacking

kwargs: UpdateEntitlementRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "StackName": ...,
}

parent.update_entitlement(**kwargs)
  1. See UpdateEntitlementRequestRequestTypeDef

update_fleet#

Updates the specified fleet.

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

# update_fleet method definition

def update_fleet(
    self,
    *,
    ImageName: str = ...,
    ImageArn: str = ...,
    Name: str = ...,
    InstanceType: str = ...,
    ComputeCapacity: ComputeCapacityTypeDef = ...,  # (1)
    VpcConfig: VpcConfigTypeDef = ...,  # (2)
    MaxUserDurationInSeconds: int = ...,
    DisconnectTimeoutInSeconds: int = ...,
    DeleteVpcConfig: bool = ...,
    Description: str = ...,
    DisplayName: str = ...,
    EnableDefaultInternetAccess: bool = ...,
    DomainJoinInfo: DomainJoinInfoTypeDef = ...,  # (3)
    IdleDisconnectTimeoutInSeconds: int = ...,
    AttributesToDelete: Sequence[FleetAttributeType] = ...,  # (4)
    IamRoleArn: str = ...,
    StreamView: StreamViewType = ...,  # (5)
    Platform: PlatformTypeType = ...,  # (6)
    MaxConcurrentSessions: int = ...,
    UsbDeviceFilterStrings: Sequence[str] = ...,
    SessionScriptS3Location: S3LocationTypeDef = ...,  # (7)
    MaxSessionsPerInstance: int = ...,
) -> UpdateFleetResultTypeDef:  # (8)
    ...
  1. See ComputeCapacityTypeDef
  2. See VpcConfigTypeDef
  3. See DomainJoinInfoTypeDef
  4. See FleetAttributeType
  5. See StreamViewType
  6. See PlatformTypeType
  7. See S3LocationTypeDef
  8. See UpdateFleetResultTypeDef 
# update_fleet method usage example with argument unpacking

kwargs: UpdateFleetRequestRequestTypeDef = {  # (1)
    "ImageName": ...,
}

parent.update_fleet(**kwargs)
  1. See UpdateFleetRequestRequestTypeDef

update_image_permissions#

Adds or updates permissions for the specified private image.

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

# update_image_permissions method definition

def update_image_permissions(
    self,
    *,
    Name: str,
    SharedAccountId: str,
    ImagePermissions: ImagePermissionsTypeDef,  # (1)
) -> dict[str, Any]:
    ...
  1. See ImagePermissionsTypeDef 
# update_image_permissions method usage example with argument unpacking

kwargs: UpdateImagePermissionsRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "SharedAccountId": ...,
    "ImagePermissions": ...,
}

parent.update_image_permissions(**kwargs)
  1. See UpdateImagePermissionsRequestRequestTypeDef

update_stack#

Updates the specified fields for the specified stack.

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

# update_stack method definition

def update_stack(
    self,
    *,
    Name: str,
    DisplayName: str = ...,
    Description: str = ...,
    StorageConnectors: Sequence[StorageConnectorTypeDef] = ...,  # (1)
    DeleteStorageConnectors: bool = ...,
    RedirectURL: str = ...,
    FeedbackURL: str = ...,
    AttributesToDelete: Sequence[StackAttributeType] = ...,  # (2)
    UserSettings: Sequence[UserSettingTypeDef] = ...,  # (3)
    ApplicationSettings: ApplicationSettingsTypeDef = ...,  # (4)
    AccessEndpoints: Sequence[AccessEndpointTypeDef] = ...,  # (5)
    EmbedHostDomains: Sequence[str] = ...,
    StreamingExperienceSettings: StreamingExperienceSettingsTypeDef = ...,  # (6)
) -> UpdateStackResultTypeDef:  # (7)
    ...
  1. See StorageConnectorTypeDef
  2. See StackAttributeType
  3. See UserSettingTypeDef
  4. See ApplicationSettingsTypeDef
  5. See AccessEndpointTypeDef
  6. See StreamingExperienceSettingsTypeDef
  7. See UpdateStackResultTypeDef 
# update_stack method usage example with argument unpacking

kwargs: UpdateStackRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.update_stack(**kwargs)
  1. See UpdateStackRequestRequestTypeDef

update_theme_for_stack#

Updates custom branding that customizes the appearance of the streaming application catalog page.

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

# update_theme_for_stack method definition

def update_theme_for_stack(
    self,
    *,
    StackName: str,
    FooterLinks: Sequence[ThemeFooterLinkTypeDef] = ...,  # (1)
    TitleText: str = ...,
    ThemeStyling: ThemeStylingType = ...,  # (2)
    OrganizationLogoS3Location: S3LocationTypeDef = ...,  # (3)
    FaviconS3Location: S3LocationTypeDef = ...,  # (3)
    State: ThemeStateType = ...,  # (5)
    AttributesToDelete: Sequence[ThemeAttributeType] = ...,  # (6)
) -> UpdateThemeForStackResultTypeDef:  # (7)
    ...
  1. See ThemeFooterLinkTypeDef
  2. See ThemeStylingType
  3. See S3LocationTypeDef
  4. See S3LocationTypeDef
  5. See ThemeStateType
  6. See ThemeAttributeType
  7. See UpdateThemeForStackResultTypeDef 
# update_theme_for_stack method usage example with argument unpacking

kwargs: UpdateThemeForStackRequestRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.update_theme_for_stack(**kwargs)
  1. See UpdateThemeForStackRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("appstream").get_paginator method with overloads.

get_waiter#

Type annotations and code completion for boto3.client("appstream").get_waiter method with overloads.