create_fleet ¶

def create_fleet(
    self,
    *,
    config_overrides: Optional[AppStreamClientConfig] = None,
    name: Optional["capo_appstream.types.name.Name"] = None,
    image_name: Optional["capo_appstream.types.name.Name"] = None,
    image_arn: Optional["capo_appstream.types.arn.Arn"] = None,
    instance_type: Optional["capo_appstream.types.string.String"] = None,
    fleet_type: Optional["capo_appstream.types.fleet_type.FleetType"] = None,
    compute_capacity: Optional[
        "capo_appstream.types.compute_capacity.ComputeCapacity"
    ] = None,
    vpc_config: Optional["capo_appstream.types.vpc_config.VpcConfig"] = None,
    max_user_duration_in_seconds: Optional[
        "capo_appstream.types.integer.Integer"
    ] = None,
    disconnect_timeout_in_seconds: Optional[
        "capo_appstream.types.integer.Integer"
    ] = None,
    description: Optional["capo_appstream.types.description.Description"] = None,
    display_name: Optional["capo_appstream.types.display_name.DisplayName"] = None,
    enable_default_internet_access: Optional[
        "capo_appstream.types.boolean_object.BooleanObject"
    ] = None,
    domain_join_info: Optional[
        "capo_appstream.types.domain_join_info.DomainJoinInfo"
    ] = None,
    tags: Optional["capo_appstream.types.tags.Tags"] = None,
    idle_disconnect_timeout_in_seconds: Optional[
        "capo_appstream.types.integer.Integer"
    ] = None,
    iam_role_arn: Optional["capo_appstream.types.arn.Arn"] = None,
    stream_view: Optional["capo_appstream.types.stream_view.StreamView"] = None,
    platform: Optional["capo_appstream.types.platform_type.PlatformType"] = None,
    max_concurrent_sessions: Optional[
        "capo_appstream.types.integer.Integer"
    ] = None,
    usb_device_filter_strings: Optional[
        "capo_appstream.types.usb_device_filter_strings.UsbDeviceFilterStrings"
    ] = None,
    session_script_s3_location: Optional[
        "capo_appstream.types.s3_location.S3Location"
    ] = None,
    max_sessions_per_instance: Optional[
        "capo_appstream.types.integer.Integer"
    ] = None,
    root_volume_config: Optional[
        "capo_appstream.types.volume_config.VolumeConfig"
    ] = None,
    disable_imdsv1: Optional[
        "capo_appstream.types.boolean_object.BooleanObject"
    ] = None,
) -> "capo_appstream.types.create_fleet_result.CreateFleetResult":
    r"""<p>Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.</p>

    Args:
        name: <p>A unique name for the fleet.</p>
        image_name: <p>The name of the image used to create the fleet.</p>
        image_arn: <p>The ARN of the public, private, or shared image to use.</p>
        instance_type: <p>The instance type to use when launching fleet instances. The following instance types are available:</p> <ul> <li> <p>stream.standard.small</p> </li> <li> <p>stream.standard.medium</p> </li> <li> <p>stream.standard.large</p> </li> <li> <p>stream.standard.xlarge</p> </li> <li> <p>stream.standard.2xlarge</p> </li> <li> <p>stream.compute.large</p> </li> <li> <p>stream.compute.xlarge</p> </li> <li> <p>stream.compute.2xlarge</p> </li> <li> <p>stream.compute.4xlarge</p> </li> <li> <p>stream.compute.8xlarge</p> </li> <li> <p>stream.memory.large</p> </li> <li> <p>stream.memory.xlarge</p> </li> <li> <p>stream.memory.2xlarge</p> </li> <li> <p>stream.memory.4xlarge</p> </li> <li> <p>stream.memory.8xlarge</p> </li> <li> <p>stream.memory.z1d.large</p> </li> <li> <p>stream.memory.z1d.xlarge</p> </li> <li> <p>stream.memory.z1d.2xlarge</p> </li> <li> <p>stream.memory.z1d.3xlarge</p> </li> <li> <p>stream.memory.z1d.6xlarge</p> </li> <li> <p>stream.memory.z1d.12xlarge</p> </li> <li> <p>stream.graphics.g4dn.xlarge</p> </li> <li> <p>stream.graphics.g4dn.2xlarge</p> </li> <li> <p>stream.graphics.g4dn.4xlarge</p> </li> <li> <p>stream.graphics.g4dn.8xlarge</p> </li> <li> <p>stream.graphics.g4dn.12xlarge</p> </li> <li> <p>stream.graphics.g4dn.16xlarge</p> </li> <li> <p>stream.graphics.g5.xlarge</p> </li> <li> <p>stream.graphics.g5.2xlarge</p> </li> <li> <p>stream.graphics.g5.4xlarge</p> </li> <li> <p>stream.graphics.g5.8xlarge</p> </li> <li> <p>stream.graphics.g5.12xlarge</p> </li> <li> <p>stream.graphics.g5.16xlarge</p> </li> <li> <p>stream.graphics.g5.24xlarge</p> </li> <li> <p>stream.graphics.g6.xlarge</p> </li> <li> <p>stream.graphics.g6.2xlarge</p> </li> <li> <p>stream.graphics.g6.4xlarge</p> </li> <li> <p>stream.graphics.g6.8xlarge</p> </li> <li> <p>stream.graphics.g6.16xlarge</p> </li> <li> <p>stream.graphics.g6.12xlarge</p> </li> <li> <p>stream.graphics.g6.24xlarge</p> </li> <li> <p>stream.graphics.gr6.4xlarge</p> </li> <li> <p>stream.graphics.gr6.8xlarge</p> </li> <li> <p>stream.graphics.g6f.large</p> </li> <li> <p>stream.graphics.g6f.xlarge</p> </li> <li> <p>stream.graphics.g6f.2xlarge</p> </li> <li> <p>stream.graphics.g6f.4xlarge</p> </li> <li> <p>stream.graphics.gr6f.4xlarge</p> </li> </ul> <p>The following instance types are available for Elastic fleets:</p> <ul> <li> <p>stream.standard.small</p> </li> <li> <p>stream.standard.medium</p> </li> <li> <p>stream.standard.large</p> </li> <li> <p>stream.standard.xlarge</p> </li> <li> <p>stream.standard.2xlarge</p> </li> </ul>
        fleet_type: <p>The fleet type.</p> <dl> <dt>ALWAYS_ON</dt> <dd> <p>Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.</p> </dd> <dt>ON_DEMAND</dt> <dd> <p>Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.</p> </dd> </dl>
        compute_capacity: <p>The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.</p>
        vpc_config: <p>The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.</p>
        max_user_duration_in_seconds: <p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</p> <p>Specify a value between 600 and 432000.</p>
        disconnect_timeout_in_seconds: <p>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. </p> <p>Specify a value between 60 and 36000.</p>
        description: <p>The description to display.</p>
        display_name: <p>The fleet name to display.</p>
        enable_default_internet_access: <p>Enables or disables default internet access for the fleet.</p>
        domain_join_info: <p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets. </p>
        tags: <p>The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \ - @</p> <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>
        idle_disconnect_timeout_in_seconds: <p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected.</p> <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.</p> <note> <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. </p> </note>
        iam_role_arn: <p>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API 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 <b>appstream_machine_role</b> credential profile on the instance.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>
        stream_view: <p>The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. When <code>APP</code> is specified, only the windows of applications opened by users display. When <code>DESKTOP</code> is specified, the standard desktop that is provided by the operating system displays.</p> <p>The default value is <code>APP</code>.</p>
        platform: <p>The fleet platform. WINDOWS_SERVER_2019, AMAZON_LINUX2 and UBUNTU_PRO_2404 are supported for Elastic fleets. </p>
        max_concurrent_sessions: <p>The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.</p>
        usb_device_filter_strings: <p>The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.</p>
        session_script_s3_location: <p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p>
        max_sessions_per_instance: <p>The maximum number of user sessions on an instance. This only applies to multi-session fleets.</p>
        root_volume_config: <p>The configuration for the root volume of fleet instances. Use this to customize storage capacity from 200 GB up to 500 GB based on your application requirements.</p>
        disable_imdsv1: <p>Set to true to disable Instance Metadata Service Version 1 (IMDSv1) and enforce IMDSv2. Set to false to enable both IMDSv1 and IMDSv2.</p> <note> <p>Before disabling IMDSv1, ensure your WorkSpaces Applications images are running the agent version or managed image update released on or after January 16, 2024 to support IMDSv2 enforcement.</p> </note>

    Raises:
        capo_appstream.errors.concurrent_modification_exception.ConcurrentModificationException: <p>An API error occurred. Wait a few minutes and try again.</p>
        capo_appstream.errors.incompatible_image_exception.IncompatibleImageException: <p>The image can't be updated because it's not compatible for updates.</p>
        capo_appstream.errors.invalid_account_status_exception.InvalidAccountStatusException: <p>The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support. </p>
        capo_appstream.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>Indicates an incorrect combination of parameters, or a missing parameter.</p>
        capo_appstream.errors.invalid_role_exception.InvalidRoleException: <p>The specified role is invalid.</p>
        capo_appstream.errors.limit_exceeded_exception.LimitExceededException: <p>The requested limit exceeds the permitted limit for an account.</p>
        capo_appstream.errors.operation_not_permitted_exception.OperationNotPermittedException: <p>The attempted operation is not permitted.</p>
        capo_appstream.errors.request_limit_exceeded_exception.RequestLimitExceededException: <p>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.</p>
        capo_appstream.errors.resource_already_exists_exception.ResourceAlreadyExistsException: <p>The specified resource already exists.</p>
        capo_appstream.errors.resource_not_available_exception.ResourceNotAvailableException: <p>The specified resource exists and is not in use, but isn't available.</p>
        capo_appstream.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_appstream.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_appstream.types.create_fleet_request.CreateFleetRequest]",
    ) -> OperationResponse[
        "capo_appstream.types.create_fleet_result.CreateFleetResult"
    ]:
        import capo_appstream._operations.photon_admin_proxy_service.create_fleet

        output, http_response = (
            capo_appstream._operations.photon_admin_proxy_service.create_fleet.create_fleet(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateFleet")
    )
    input_: capo_appstream.types.create_fleet_request.CreateFleetRequest = {}
    if name is not None:
        input_["name"] = name
    if image_name is not None:
        input_["image_name"] = image_name
    if image_arn is not None:
        input_["image_arn"] = image_arn
    if instance_type is not None:
        input_["instance_type"] = instance_type
    if fleet_type is not None:
        input_["fleet_type"] = fleet_type
    if compute_capacity is not None:
        input_["compute_capacity"] = compute_capacity
    if vpc_config is not None:
        input_["vpc_config"] = vpc_config
    if max_user_duration_in_seconds is not None:
        input_["max_user_duration_in_seconds"] = max_user_duration_in_seconds
    if disconnect_timeout_in_seconds is not None:
        input_["disconnect_timeout_in_seconds"] = disconnect_timeout_in_seconds
    if description is not None:
        input_["description"] = description
    if display_name is not None:
        input_["display_name"] = display_name
    if enable_default_internet_access is not None:
        input_["enable_default_internet_access"] = enable_default_internet_access
    if domain_join_info is not None:
        input_["domain_join_info"] = domain_join_info
    if tags is not None:
        input_["tags"] = tags
    if idle_disconnect_timeout_in_seconds is not None:
        input_["idle_disconnect_timeout_in_seconds"] = (
            idle_disconnect_timeout_in_seconds
        )
    if iam_role_arn is not None:
        input_["iam_role_arn"] = iam_role_arn
    if stream_view is not None:
        input_["stream_view"] = stream_view
    if platform is not None:
        input_["platform"] = platform
    if max_concurrent_sessions is not None:
        input_["max_concurrent_sessions"] = max_concurrent_sessions
    if usb_device_filter_strings is not None:
        input_["usb_device_filter_strings"] = usb_device_filter_strings
    if session_script_s3_location is not None:
        input_["session_script_s3_location"] = session_script_s3_location
    if max_sessions_per_instance is not None:
        input_["max_sessions_per_instance"] = max_sessions_per_instance
    if root_volume_config is not None:
        input_["root_volume_config"] = root_volume_config
    if disable_imdsv1 is not None:
        input_["disable_imdsv1"] = disable_imdsv1

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output