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
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.
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)
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
def associate_application_fleet(
self,
*,
FleetName: str,
ApplicationArn: str,
) -> AssociateApplicationFleetResultTypeDef: # (1)
...
kwargs: AssociateApplicationFleetRequestRequestTypeDef = { # (1)
"FleetName": ...,
"ApplicationArn": ...,
}
parent.associate_application_fleet(**kwargs)
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
def associate_application_to_entitlement(
self,
*,
StackName: str,
EntitlementName: str,
ApplicationIdentifier: str,
) -> Dict[str, Any]:
...
kwargs: AssociateApplicationToEntitlementRequestRequestTypeDef = { # (1)
"StackName": ...,
"EntitlementName": ...,
"ApplicationIdentifier": ...,
}
parent.associate_application_to_entitlement(**kwargs)
associate_fleet
Associates the specified fleet with the specified stack.
Type annotations and code completion for boto3.client("appstream").associate_fleet
method.
boto3 documentation
def associate_fleet(
self,
*,
FleetName: str,
StackName: str,
) -> Dict[str, Any]:
...
kwargs: AssociateFleetRequestRequestTypeDef = { # (1)
"FleetName": ...,
"StackName": ...,
}
parent.associate_fleet(**kwargs)
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
def batch_associate_user_stack(
self,
*,
UserStackAssociations: Sequence[UserStackAssociationTypeDef], # (1)
) -> BatchAssociateUserStackResultTypeDef: # (2)
...
kwargs: BatchAssociateUserStackRequestRequestTypeDef = { # (1)
"UserStackAssociations": ...,
}
parent.batch_associate_user_stack(**kwargs)
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
def batch_disassociate_user_stack(
self,
*,
UserStackAssociations: Sequence[UserStackAssociationTypeDef], # (1)
) -> BatchDisassociateUserStackResultTypeDef: # (2)
...
kwargs: BatchDisassociateUserStackRequestRequestTypeDef = { # (1)
"UserStackAssociations": ...,
}
parent.batch_disassociate_user_stack(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("appstream").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("appstream").close
method.
boto3 documentation
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
def copy_image(
self,
*,
SourceImageName: str,
DestinationImageName: str,
DestinationRegion: str,
DestinationImageDescription: str = ...,
) -> CopyImageResponseTypeDef: # (1)
...
kwargs: CopyImageRequestRequestTypeDef = { # (1)
"SourceImageName": ...,
"DestinationImageName": ...,
"DestinationRegion": ...,
}
parent.copy_image(**kwargs)
create_app_block
Creates an app block.
Type annotations and code completion for boto3.client("appstream").create_app_block
method.
boto3 documentation
def create_app_block(
self,
*,
Name: str,
SourceS3Location: S3LocationTypeDef, # (1)
SetupScriptDetails: ScriptDetailsTypeDef, # (2)
Description: str = ...,
DisplayName: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateAppBlockResultTypeDef: # (3)
...
kwargs: CreateAppBlockRequestRequestTypeDef = { # (1)
"Name": ...,
"SourceS3Location": ...,
"SetupScriptDetails": ...,
}
parent.create_app_block(**kwargs)
create_application
Creates an application.
Type annotations and code completion for boto3.client("appstream").create_application
method.
boto3 documentation
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)
...
kwargs: CreateApplicationRequestRequestTypeDef = { # (1)
"Name": ...,
"IconS3Location": ...,
"LaunchPath": ...,
"Platforms": ...,
"InstanceFamilies": ...,
"AppBlockArn": ...,
}
parent.create_application(**kwargs)
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
def create_directory_config(
self,
*,
DirectoryName: str,
OrganizationalUnitDistinguishedNames: Sequence[str],
ServiceAccountCredentials: ServiceAccountCredentialsTypeDef = ..., # (1)
CertificateBasedAuthProperties: CertificateBasedAuthPropertiesTypeDef = ..., # (2)
) -> CreateDirectoryConfigResultTypeDef: # (3)
...
- See ServiceAccountCredentialsTypeDef
- See CertificateBasedAuthPropertiesTypeDef
- See CreateDirectoryConfigResultTypeDef
kwargs: CreateDirectoryConfigRequestRequestTypeDef = { # (1)
"DirectoryName": ...,
"OrganizationalUnitDistinguishedNames": ...,
}
parent.create_directory_config(**kwargs)
create_entitlement
Creates a new entitlement.
Type annotations and code completion for boto3.client("appstream").create_entitlement
method.
boto3 documentation
def create_entitlement(
self,
*,
Name: str,
StackName: str,
AppVisibility: AppVisibilityType, # (1)
Attributes: Sequence[EntitlementAttributeTypeDef], # (2)
Description: str = ...,
) -> CreateEntitlementResultTypeDef: # (3)
...
kwargs: CreateEntitlementRequestRequestTypeDef = { # (1)
"Name": ...,
"StackName": ...,
"AppVisibility": ...,
"Attributes": ...,
}
parent.create_entitlement(**kwargs)
create_fleet
Creates a fleet.
Type annotations and code completion for boto3.client("appstream").create_fleet
method.
boto3 documentation
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)
...
- See FleetTypeType
- See ComputeCapacityTypeDef
- See VpcConfigTypeDef
- See DomainJoinInfoTypeDef
- See StreamViewType
- See PlatformTypeType
- See S3LocationTypeDef
- See CreateFleetResultTypeDef
kwargs: CreateFleetRequestRequestTypeDef = { # (1)
"Name": ...,
"InstanceType": ...,
}
parent.create_fleet(**kwargs)
create_image_builder
Creates an image builder.
Type annotations and code completion for boto3.client("appstream").create_image_builder
method.
boto3 documentation
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)
...
- See VpcConfigTypeDef
- See DomainJoinInfoTypeDef
- See AccessEndpointTypeDef
- See CreateImageBuilderResultTypeDef
kwargs: CreateImageBuilderRequestRequestTypeDef = { # (1)
"Name": ...,
"InstanceType": ...,
}
parent.create_image_builder(**kwargs)
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
def create_image_builder_streaming_url(
self,
*,
Name: str,
Validity: int = ...,
) -> CreateImageBuilderStreamingURLResultTypeDef: # (1)
...
kwargs: CreateImageBuilderStreamingURLRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_image_builder_streaming_url(**kwargs)
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
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)
...
- See StorageConnectorTypeDef
- See UserSettingTypeDef
- See ApplicationSettingsTypeDef
- See AccessEndpointTypeDef
- See StreamingExperienceSettingsTypeDef
- See CreateStackResultTypeDef
kwargs: CreateStackRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_stack(**kwargs)
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
def create_streaming_url(
self,
*,
StackName: str,
FleetName: str,
UserId: str,
ApplicationId: str = ...,
Validity: int = ...,
SessionContext: str = ...,
) -> CreateStreamingURLResultTypeDef: # (1)
...
kwargs: CreateStreamingURLRequestRequestTypeDef = { # (1)
"StackName": ...,
"FleetName": ...,
"UserId": ...,
}
parent.create_streaming_url(**kwargs)
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
def create_updated_image(
self,
*,
existingImageName: str,
newImageName: str,
newImageDescription: str = ...,
newImageDisplayName: str = ...,
newImageTags: Mapping[str, str] = ...,
dryRun: bool = ...,
) -> CreateUpdatedImageResultTypeDef: # (1)
...
kwargs: CreateUpdatedImageRequestRequestTypeDef = { # (1)
"existingImageName": ...,
"newImageName": ...,
}
parent.create_updated_image(**kwargs)
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
def create_usage_report_subscription(
self,
) -> CreateUsageReportSubscriptionResultTypeDef: # (1)
...
create_user
Creates a new user in the user pool.
Type annotations and code completion for boto3.client("appstream").create_user
method.
boto3 documentation
def create_user(
self,
*,
UserName: str,
AuthenticationType: AuthenticationTypeType, # (1)
MessageAction: MessageActionType = ..., # (2)
FirstName: str = ...,
LastName: str = ...,
) -> Dict[str, Any]:
...
kwargs: CreateUserRequestRequestTypeDef = { # (1)
"UserName": ...,
"AuthenticationType": ...,
}
parent.create_user(**kwargs)
delete_app_block
Deletes an app block.
Type annotations and code completion for boto3.client("appstream").delete_app_block
method.
boto3 documentation
kwargs: DeleteAppBlockRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_app_block(**kwargs)
delete_application
Deletes an application.
Type annotations and code completion for boto3.client("appstream").delete_application
method.
boto3 documentation
kwargs: DeleteApplicationRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_application(**kwargs)
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
kwargs: DeleteDirectoryConfigRequestRequestTypeDef = { # (1)
"DirectoryName": ...,
}
parent.delete_directory_config(**kwargs)
delete_entitlement
Deletes the specified entitlement.
Type annotations and code completion for boto3.client("appstream").delete_entitlement
method.
boto3 documentation
def delete_entitlement(
self,
*,
Name: str,
StackName: str,
) -> Dict[str, Any]:
...
kwargs: DeleteEntitlementRequestRequestTypeDef = { # (1)
"Name": ...,
"StackName": ...,
}
parent.delete_entitlement(**kwargs)
delete_fleet
Deletes the specified fleet.
Type annotations and code completion for boto3.client("appstream").delete_fleet
method.
boto3 documentation
kwargs: DeleteFleetRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_fleet(**kwargs)
delete_image
Deletes the specified image.
Type annotations and code completion for boto3.client("appstream").delete_image
method.
boto3 documentation
kwargs: DeleteImageRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_image(**kwargs)
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
def delete_image_builder(
self,
*,
Name: str,
) -> DeleteImageBuilderResultTypeDef: # (1)
...
kwargs: DeleteImageBuilderRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_image_builder(**kwargs)
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
def delete_image_permissions(
self,
*,
Name: str,
SharedAccountId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteImagePermissionsRequestRequestTypeDef = { # (1)
"Name": ...,
"SharedAccountId": ...,
}
parent.delete_image_permissions(**kwargs)
delete_stack
Deletes the specified stack.
Type annotations and code completion for boto3.client("appstream").delete_stack
method.
boto3 documentation
kwargs: DeleteStackRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_stack(**kwargs)
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_user
Deletes a user from the user pool.
Type annotations and code completion for boto3.client("appstream").delete_user
method.
boto3 documentation
def delete_user(
self,
*,
UserName: str,
AuthenticationType: AuthenticationTypeType, # (1)
) -> Dict[str, Any]:
...
kwargs: DeleteUserRequestRequestTypeDef = { # (1)
"UserName": ...,
"AuthenticationType": ...,
}
parent.delete_user(**kwargs)
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
def describe_app_blocks(
self,
*,
Arns: Sequence[str] = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeAppBlocksResultTypeDef: # (1)
...
kwargs: DescribeAppBlocksRequestRequestTypeDef = { # (1)
"Arns": ...,
}
parent.describe_app_blocks(**kwargs)
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
def describe_application_fleet_associations(
self,
*,
FleetName: str = ...,
ApplicationArn: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeApplicationFleetAssociationsResultTypeDef: # (1)
...
kwargs: DescribeApplicationFleetAssociationsRequestRequestTypeDef = { # (1)
"FleetName": ...,
}
parent.describe_application_fleet_associations(**kwargs)
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
def describe_applications(
self,
*,
Arns: Sequence[str] = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeApplicationsResultTypeDef: # (1)
...
kwargs: DescribeApplicationsRequestRequestTypeDef = { # (1)
"Arns": ...,
}
parent.describe_applications(**kwargs)
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
def describe_directory_configs(
self,
*,
DirectoryNames: Sequence[str] = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeDirectoryConfigsResultTypeDef: # (1)
...
kwargs: DescribeDirectoryConfigsRequestRequestTypeDef = { # (1)
"DirectoryNames": ...,
}
parent.describe_directory_configs(**kwargs)
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
def describe_entitlements(
self,
*,
StackName: str,
Name: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeEntitlementsResultTypeDef: # (1)
...
kwargs: DescribeEntitlementsRequestRequestTypeDef = { # (1)
"StackName": ...,
}
parent.describe_entitlements(**kwargs)
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
def describe_fleets(
self,
*,
Names: Sequence[str] = ...,
NextToken: str = ...,
) -> DescribeFleetsResultTypeDef: # (1)
...
kwargs: DescribeFleetsRequestRequestTypeDef = { # (1)
"Names": ...,
}
parent.describe_fleets(**kwargs)
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
def describe_image_builders(
self,
*,
Names: Sequence[str] = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeImageBuildersResultTypeDef: # (1)
...
kwargs: DescribeImageBuildersRequestRequestTypeDef = { # (1)
"Names": ...,
}
parent.describe_image_builders(**kwargs)
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
def describe_image_permissions(
self,
*,
Name: str,
MaxResults: int = ...,
SharedAwsAccountIds: Sequence[str] = ...,
NextToken: str = ...,
) -> DescribeImagePermissionsResultTypeDef: # (1)
...
kwargs: DescribeImagePermissionsRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.describe_image_permissions(**kwargs)
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
def describe_images(
self,
*,
Names: Sequence[str] = ...,
Arns: Sequence[str] = ...,
Type: VisibilityTypeType = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeImagesResultTypeDef: # (2)
...
kwargs: DescribeImagesRequestRequestTypeDef = { # (1)
"Names": ...,
}
parent.describe_images(**kwargs)
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
def describe_sessions(
self,
*,
StackName: str,
FleetName: str,
UserId: str = ...,
NextToken: str = ...,
Limit: int = ...,
AuthenticationType: AuthenticationTypeType = ..., # (1)
) -> DescribeSessionsResultTypeDef: # (2)
...
kwargs: DescribeSessionsRequestRequestTypeDef = { # (1)
"StackName": ...,
"FleetName": ...,
}
parent.describe_sessions(**kwargs)
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
def describe_stacks(
self,
*,
Names: Sequence[str] = ...,
NextToken: str = ...,
) -> DescribeStacksResultTypeDef: # (1)
...
kwargs: DescribeStacksRequestRequestTypeDef = { # (1)
"Names": ...,
}
parent.describe_stacks(**kwargs)
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
def describe_usage_report_subscriptions(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeUsageReportSubscriptionsResultTypeDef: # (1)
...
kwargs: DescribeUsageReportSubscriptionsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.describe_usage_report_subscriptions(**kwargs)
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
def describe_user_stack_associations(
self,
*,
StackName: str = ...,
UserName: str = ...,
AuthenticationType: AuthenticationTypeType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeUserStackAssociationsResultTypeDef: # (2)
...
kwargs: DescribeUserStackAssociationsRequestRequestTypeDef = { # (1)
"StackName": ...,
}
parent.describe_user_stack_associations(**kwargs)
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
def describe_users(
self,
*,
AuthenticationType: AuthenticationTypeType, # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeUsersResultTypeDef: # (2)
...
kwargs: DescribeUsersRequestRequestTypeDef = { # (1)
"AuthenticationType": ...,
}
parent.describe_users(**kwargs)
disable_user
Disables the specified user in the user pool.
Type annotations and code completion for boto3.client("appstream").disable_user
method.
boto3 documentation
def disable_user(
self,
*,
UserName: str,
AuthenticationType: AuthenticationTypeType, # (1)
) -> Dict[str, Any]:
...
kwargs: DisableUserRequestRequestTypeDef = { # (1)
"UserName": ...,
"AuthenticationType": ...,
}
parent.disable_user(**kwargs)
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
def disassociate_application_fleet(
self,
*,
FleetName: str,
ApplicationArn: str,
) -> Dict[str, Any]:
...
kwargs: DisassociateApplicationFleetRequestRequestTypeDef = { # (1)
"FleetName": ...,
"ApplicationArn": ...,
}
parent.disassociate_application_fleet(**kwargs)
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
def disassociate_application_from_entitlement(
self,
*,
StackName: str,
EntitlementName: str,
ApplicationIdentifier: str,
) -> Dict[str, Any]:
...
kwargs: DisassociateApplicationFromEntitlementRequestRequestTypeDef = { # (1)
"StackName": ...,
"EntitlementName": ...,
"ApplicationIdentifier": ...,
}
parent.disassociate_application_from_entitlement(**kwargs)
disassociate_fleet
Disassociates the specified fleet from the specified stack.
Type annotations and code completion for boto3.client("appstream").disassociate_fleet
method.
boto3 documentation
def disassociate_fleet(
self,
*,
FleetName: str,
StackName: str,
) -> Dict[str, Any]:
...
kwargs: DisassociateFleetRequestRequestTypeDef = { # (1)
"FleetName": ...,
"StackName": ...,
}
parent.disassociate_fleet(**kwargs)
enable_user
Enables a user in the user pool.
Type annotations and code completion for boto3.client("appstream").enable_user
method.
boto3 documentation
def enable_user(
self,
*,
UserName: str,
AuthenticationType: AuthenticationTypeType, # (1)
) -> Dict[str, Any]:
...
kwargs: EnableUserRequestRequestTypeDef = { # (1)
"UserName": ...,
"AuthenticationType": ...,
}
parent.enable_user(**kwargs)
expire_session
Immediately stops the specified streaming session.
Type annotations and code completion for boto3.client("appstream").expire_session
method.
boto3 documentation
kwargs: ExpireSessionRequestRequestTypeDef = { # (1)
"SessionId": ...,
}
parent.expire_session(**kwargs)
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
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
def list_associated_fleets(
self,
*,
StackName: str,
NextToken: str = ...,
) -> ListAssociatedFleetsResultTypeDef: # (1)
...
kwargs: ListAssociatedFleetsRequestRequestTypeDef = { # (1)
"StackName": ...,
}
parent.list_associated_fleets(**kwargs)
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
def list_associated_stacks(
self,
*,
FleetName: str,
NextToken: str = ...,
) -> ListAssociatedStacksResultTypeDef: # (1)
...
kwargs: ListAssociatedStacksRequestRequestTypeDef = { # (1)
"FleetName": ...,
}
parent.list_associated_stacks(**kwargs)
list_entitled_applications
Retrieves a list of entitled applications.
Type annotations and code completion for boto3.client("appstream").list_entitled_applications
method.
boto3 documentation
def list_entitled_applications(
self,
*,
StackName: str,
EntitlementName: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListEntitledApplicationsResultTypeDef: # (1)
...
kwargs: ListEntitledApplicationsRequestRequestTypeDef = { # (1)
"StackName": ...,
"EntitlementName": ...,
}
parent.list_entitled_applications(**kwargs)
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
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
start_fleet
Starts the specified fleet.
Type annotations and code completion for boto3.client("appstream").start_fleet
method.
boto3 documentation
kwargs: StartFleetRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.start_fleet(**kwargs)
start_image_builder
Starts the specified image builder.
Type annotations and code completion for boto3.client("appstream").start_image_builder
method.
boto3 documentation
def start_image_builder(
self,
*,
Name: str,
AppstreamAgentVersion: str = ...,
) -> StartImageBuilderResultTypeDef: # (1)
...
kwargs: StartImageBuilderRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.start_image_builder(**kwargs)
stop_fleet
Stops the specified fleet.
Type annotations and code completion for boto3.client("appstream").stop_fleet
method.
boto3 documentation
kwargs: StopFleetRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.stop_fleet(**kwargs)
stop_image_builder
Stops the specified image builder.
Type annotations and code completion for boto3.client("appstream").stop_image_builder
method.
boto3 documentation
def stop_image_builder(
self,
*,
Name: str,
) -> StopImageBuilderResultTypeDef: # (1)
...
kwargs: StopImageBuilderRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.stop_image_builder(**kwargs)
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
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
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
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_application
Updates the specified application.
Type annotations and code completion for boto3.client("appstream").update_application
method.
boto3 documentation
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)
...
kwargs: UpdateApplicationRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.update_application(**kwargs)
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
def update_directory_config(
self,
*,
DirectoryName: str,
OrganizationalUnitDistinguishedNames: Sequence[str] = ...,
ServiceAccountCredentials: ServiceAccountCredentialsTypeDef = ..., # (1)
CertificateBasedAuthProperties: CertificateBasedAuthPropertiesTypeDef = ..., # (2)
) -> UpdateDirectoryConfigResultTypeDef: # (3)
...
- See ServiceAccountCredentialsTypeDef
- See CertificateBasedAuthPropertiesTypeDef
- See UpdateDirectoryConfigResultTypeDef
kwargs: UpdateDirectoryConfigRequestRequestTypeDef = { # (1)
"DirectoryName": ...,
}
parent.update_directory_config(**kwargs)
update_entitlement
Updates the specified entitlement.
Type annotations and code completion for boto3.client("appstream").update_entitlement
method.
boto3 documentation
def update_entitlement(
self,
*,
Name: str,
StackName: str,
Description: str = ...,
AppVisibility: AppVisibilityType = ..., # (1)
Attributes: Sequence[EntitlementAttributeTypeDef] = ..., # (2)
) -> UpdateEntitlementResultTypeDef: # (3)
...
kwargs: UpdateEntitlementRequestRequestTypeDef = { # (1)
"Name": ...,
"StackName": ...,
}
parent.update_entitlement(**kwargs)
update_fleet
Updates the specified fleet.
Type annotations and code completion for boto3.client("appstream").update_fleet
method.
boto3 documentation
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)
) -> UpdateFleetResultTypeDef: # (8)
...
- See ComputeCapacityTypeDef
- See VpcConfigTypeDef
- See DomainJoinInfoTypeDef
- See FleetAttributeType
- See StreamViewType
- See PlatformTypeType
- See S3LocationTypeDef
- See UpdateFleetResultTypeDef
kwargs: UpdateFleetRequestRequestTypeDef = { # (1)
"ImageName": ...,
}
parent.update_fleet(**kwargs)
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
def update_image_permissions(
self,
*,
Name: str,
SharedAccountId: str,
ImagePermissions: ImagePermissionsTypeDef, # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateImagePermissionsRequestRequestTypeDef = { # (1)
"Name": ...,
"SharedAccountId": ...,
"ImagePermissions": ...,
}
parent.update_image_permissions(**kwargs)
update_stack
Updates the specified fields for the specified stack.
Type annotations and code completion for boto3.client("appstream").update_stack
method.
boto3 documentation
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)
...
- See StorageConnectorTypeDef
- See StackAttributeType
- See UserSettingTypeDef
- See ApplicationSettingsTypeDef
- See AccessEndpointTypeDef
- See StreamingExperienceSettingsTypeDef
- See UpdateStackResultTypeDef
kwargs: UpdateStackRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.update_stack(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("appstream").get_paginator
method with overloads.
client.get_paginator("describe_directory_configs")
-> DescribeDirectoryConfigsPaginatorclient.get_paginator("describe_fleets")
-> DescribeFleetsPaginatorclient.get_paginator("describe_image_builders")
-> DescribeImageBuildersPaginatorclient.get_paginator("describe_images")
-> DescribeImagesPaginatorclient.get_paginator("describe_sessions")
-> DescribeSessionsPaginatorclient.get_paginator("describe_stacks")
-> DescribeStacksPaginatorclient.get_paginator("describe_user_stack_associations")
-> DescribeUserStackAssociationsPaginatorclient.get_paginator("describe_users")
-> DescribeUsersPaginatorclient.get_paginator("list_associated_fleets")
-> ListAssociatedFleetsPaginatorclient.get_paginator("list_associated_stacks")
-> ListAssociatedStacksPaginator
get_waiter
Type annotations and code completion for boto3.client("appstream").get_waiter
method with overloads.
client.get_waiter("fleet_started")
-> FleetStartedWaiterclient.get_waiter("fleet_stopped")
-> FleetStoppedWaiter