Skip to content

list_assets

list_assets(
    outpost_identifier: OutpostIdentifier,
    *,
    config_overrides: Optional[OutpostsClientConfig] = None,
    host_id_filter: Optional[HostIdList] = None,
    max_results: Optional[MaxResults1000] = None,
    next_token: Optional[Token] = None,
    status_filter: Optional[StatusList] = None,
    asset_type_filter: Optional[AssetTypeList] = None,
) -> ListAssetsOutput

Lists the hardware assets for the specified Outpost.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

Parameters:

  • outpost_identifier (OutpostIdentifier) –

    The ID or the Amazon Resource Name (ARN) of the Outpost.

  • host_id_filter (Optional[HostIdList], default: None ) –

    Filters the results by the host ID of a Dedicated Host.

  • status_filter (Optional[StatusList], default: None ) –

    Filters the results by state.

  • asset_type_filter (Optional[AssetTypeList], default: None ) –

    Filters the results by asset type.

    • COMPUTE - Server asset used for customer compute

    • STORAGE - Server asset used by storage services

    • POWERSHELF - Powershelf assets

    • SWITCH - Switch assets

    • NETWORKING - Asset managed by Amazon Web Services for networking purposes

Raises:

Source code in docs_src/capo_outposts/_services/outposts.py
def list_assets(
    self,
    outpost_identifier: "capo_outposts.types.outpost_identifier.OutpostIdentifier",
    *,
    config_overrides: Optional[OutpostsClientConfig] = None,
    host_id_filter: Optional["capo_outposts.types.host_id_list.HostIdList"] = None,
    max_results: Optional[
        "capo_outposts.types.max_results1000.MaxResults1000"
    ] = None,
    next_token: Optional["capo_outposts.types.token.Token"] = None,
    status_filter: Optional["capo_outposts.types.status_list.StatusList"] = None,
    asset_type_filter: Optional[
        "capo_outposts.types.asset_type_list.AssetTypeList"
    ] = None,
) -> "capo_outposts.types.list_assets_output.ListAssetsOutput":
    """<p>Lists the hardware assets for the specified Outpost.</p> <p>Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.</p>

    Args:
        outpost_identifier: <p> The ID or the Amazon Resource Name (ARN) of the Outpost. </p>
        host_id_filter: <p>Filters the results by the host ID of a Dedicated Host.</p>
        status_filter: <p>Filters the results by state.</p>
        asset_type_filter: <p>Filters the results by asset type.</p> <ul> <li> <p>COMPUTE - Server asset used for customer compute </p> </li> <li> <p>STORAGE - Server asset used by storage services </p> </li> <li> <p>POWERSHELF - Powershelf assets </p> </li> <li> <p>SWITCH - Switch assets </p> </li> <li> <p>NETWORKING - Asset managed by Amazon Web Services for networking purposes </p> </li> </ul>

    Raises:
        capo_outposts.errors.access_denied_exception.AccessDeniedException: <p>You do not have permission to perform this operation.</p>
        capo_outposts.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred.</p>
        capo_outposts.errors.not_found_exception.NotFoundException: <p>The specified request is not valid.</p>
        capo_outposts.errors.validation_exception.ValidationException: <p>A parameter is not valid.</p>
        capo_outposts.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_outposts.types.list_assets_input.ListAssetsInput]",
    ) -> OperationResponse[
        "capo_outposts.types.list_assets_output.ListAssetsOutput"
    ]:
        import capo_outposts._operations.outposts_olaf_service.list_assets

        output, http_response = (
            capo_outposts._operations.outposts_olaf_service.list_assets.list_assets(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAssets")
    )
    input_: capo_outposts.types.list_assets_input.ListAssetsInput = {
        "outpost_identifier": outpost_identifier
    }
    if host_id_filter is not None:
        input_["host_id_filter"] = host_id_filter
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if status_filter is not None:
        input_["status_filter"] = status_filter
    if asset_type_filter is not None:
        input_["asset_type_filter"] = asset_type_filter

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