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#

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

can_paginate#

Check if an operation can be paginated.

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:
    ...

close#

Closes underlying endpoint connections.

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

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

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