update_app_block_builder
async
¶
update_app_block_builder(
*,
config_overrides: Optional[AsyncAppStreamClientConfig] = None,
name: Optional[Name] = None,
description: Optional[Description] = None,
display_name: Optional[DisplayName] = None,
platform: Optional[PlatformType] = None,
instance_type: Optional[String] = None,
vpc_config: Optional[VpcConfig] = None,
enable_default_internet_access: Optional[BooleanObject] = None,
iam_role_arn: Optional[Arn] = None,
access_endpoints: Optional[AccessEndpointList] = None,
attributes_to_delete: Optional[AppBlockBuilderAttributes] = None,
disable_imdsv1: Optional[BooleanObject] = None,
) -> UpdateAppBlockBuilderResult
Updates an app block builder.
If the app block builder is in the STARTING or STOPPING state, you can't update it. If the app block builder is in the RUNNING state, you can only update the DisplayName and Description. If the app block builder is in the STOPPED state, you can update any attribute except the Name.
Parameters:
-
name(Optional[Name], default:None) –The unique name for the app block builder.
-
description(Optional[Description], default:None) –The description of the app block builder.
-
display_name(Optional[DisplayName], default:None) –The display name of the app block builder.
-
platform(Optional[PlatformType], default:None) –The platform of the app block builder.
WINDOWS_SERVER_2019is the only valid value. -
instance_type(Optional[String], default:None) –The instance type to use when launching the app block builder. The following instance types are available:
-
stream.standard.small
-
stream.standard.medium
-
stream.standard.large
-
stream.standard.xlarge
-
stream.standard.2xlarge
-
-
vpc_config(Optional[VpcConfig], default:None) –The VPC configuration for the app block builder.
App block builders require that you specify at least two subnets in different availability zones.
-
enable_default_internet_access(Optional[BooleanObject], default:None) –Enables or disables default internet access for the app block builder.
-
iam_role_arn(Optional[Arn], default:None) –The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To assume a role, the app block builder calls the AWS Security Token Service (STS)
AssumeRoleAPI operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
-
access_endpoints(Optional[AccessEndpointList], default:None) –The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.
-
attributes_to_delete(Optional[AppBlockBuilderAttributes], default:None) –The attributes to delete from the app block builder.
-
disable_imdsv1(Optional[BooleanObject], default:None) –Set to true to disable Instance Metadata Service Version 1 (IMDSv1) and enforce IMDSv2. Set to false to enable both IMDSv1 and IMDSv2.
Raises:
-
ConcurrentModificationException–An API error occurred. Wait a few minutes and try again.
-
InvalidAccountStatusException–The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
-
InvalidParameterCombinationException–Indicates an incorrect combination of parameters, or a missing parameter.
-
InvalidRoleException–The specified role is invalid.
-
LimitExceededException–The requested limit exceeds the permitted limit for an account.
-
OperationNotPermittedException–The attempted operation is not permitted.
-
RequestLimitExceededException–WorkSpaces Applications can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.
-
ResourceInUseException–The specified resource is in use.
-
ResourceNotAvailableException–The specified resource exists and is not in use, but isn't available.
-
ResourceNotFoundException–The specified resource was not found.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_appstream/_services/async_app_stream.py
5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 | |