describe_image_builders `async` ¶

describe_image_builders(
    *,
    config_overrides: Optional[AsyncAppStreamClientConfig] = None,
    names: Optional[StringList] = None,
    max_results: Optional[Integer] = None,
    next_token: Optional[String] = None,
) -> DescribeImageBuildersResult

Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.

Parameters:

names (Optional[StringList], default: None ) –

The names of the image builders to describe.
max_results (Optional[Integer], default: None ) –

The maximum size of each page of results.
next_token (Optional[String], default: None ) –

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Raises:

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

async def describe_image_builders(
    self,
    *,
    config_overrides: Optional[AsyncAppStreamClientConfig] = None,
    names: Optional["capo_appstream.types.string_list.StringList"] = None,
    max_results: Optional["capo_appstream.types.integer.Integer"] = None,
    next_token: Optional["capo_appstream.types.string.String"] = None,
) -> "capo_appstream.types.describe_image_builders_result.DescribeImageBuildersResult":
    """<p>Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.</p>

    Args:
        names: <p>The names of the image builders to describe.</p>
        max_results: <p>The maximum size of each page of results.</p>
        next_token: <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>

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

    async def _handler(
        req: "AsyncOperationRequest[capo_appstream.types.describe_image_builders_request.DescribeImageBuildersRequest]",
    ) -> AsyncOperationResponse[
        "capo_appstream.types.describe_image_builders_result.DescribeImageBuildersResult"
    ]:
        import capo_appstream._operations.photon_admin_proxy_service.describe_image_builders

        (
            output,
            http_response,
        ) = await capo_appstream._operations.photon_admin_proxy_service.describe_image_builders.async_describe_image_builders(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeImageBuilders")
    )
    input_: capo_appstream.types.describe_image_builders_request.DescribeImageBuildersRequest = {}
    if names is not None:
        input_["names"] = names
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_image_builders async ¶

describe_image_builders `async` ¶