get_apps_list `async` ¶

get_apps_list(
    list_id: ListId,
    *,
    config_overrides: Optional[AsyncFMSClientConfig] = None,
    default_list: Optional[Boolean] = None,
) -> GetAppsListResponse

Returns information about the specified Firewall Manager applications list.

Parameters:

list_id (ListId) –

The ID of the Firewall Manager applications list that you want the details for.
default_list (Optional[Boolean], default: None ) –

Specifies whether the list to retrieve is a default list owned by Firewall Manager.

Raises:

InternalErrorException –

The operation failed because of a system problem, even though the request was valid. Retry your request.
InvalidOperationException –

The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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_fms/_services/async_fms.py

async def get_apps_list(
    self,
    list_id: "capo_fms.types.list_id.ListId",
    *,
    config_overrides: Optional[AsyncFMSClientConfig] = None,
    default_list: Optional["capo_fms.types.boolean.Boolean"] = None,
) -> "capo_fms.types.get_apps_list_response.GetAppsListResponse":
    """<p>Returns information about the specified Firewall Manager applications list.</p>

    Args:
        list_id: <p>The ID of the Firewall Manager applications list that you want the details for.</p>
        default_list: <p>Specifies whether the list to retrieve is a default list owned by Firewall Manager.</p>

    Raises:
        capo_fms.errors.internal_error_exception.InternalErrorException: <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
        capo_fms.errors.invalid_operation_exception.InvalidOperationException: <p>The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an <code>AssociateAdminAccount</code> request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.</p>
        capo_fms.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_fms.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_fms.types.get_apps_list_request.GetAppsListRequest]",
    ) -> AsyncOperationResponse[
        "capo_fms.types.get_apps_list_response.GetAppsListResponse"
    ]:
        import capo_fms._operations.awsfms_20180101.get_apps_list

        (
            output,
            http_response,
        ) = await capo_fms._operations.awsfms_20180101.get_apps_list.async_get_apps_list(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAppsList")
    )
    input_: capo_fms.types.get_apps_list_request.GetAppsListRequest = {
        "list_id": list_id
    }
    if default_list is not None:
        input_["default_list"] = default_list

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

get_apps_list async ¶

get_apps_list `async` ¶