Skip to content

list_access_profiles async

list_access_profiles(
    space_id: SpaceId,
    *,
    config_overrides: Optional[AsyncCloudWatchOmniClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[int] = None,
) -> ListAccessProfilesOutput

Returns the access profiles in a space.

Parameters:

  • space_id (SpaceId) –

    The unique ID of the space.

  • next_token (Optional[NextToken], default: None ) –

    A token to retrieve the next page of results.

  • max_results (Optional[int], default: None ) –

    The maximum number of access profiles to return per page. Defaults to 100.

Raises:

Examples:

List access profiles in a space The following example lists the first page of access profiles in a space and returns a nextToken to retrieve the next page. Payloads are shown as JSON; on the wire they are CBOR-encoded.

>>> await client.list_access_profiles(space_id='a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d', max_results=50)
Source code in docs_src/capo_cloudwatchomni/_services/async_cloud_watch_omni.py
async def list_access_profiles(
    self,
    space_id: "capo_cloudwatchomni.types.space_id.SpaceId",
    *,
    config_overrides: Optional[AsyncCloudWatchOmniClientConfig] = None,
    next_token: Optional["capo_cloudwatchomni.types.next_token.NextToken"] = None,
    max_results: Optional[int] = None,
) -> (
    "capo_cloudwatchomni.types.list_access_profiles_output.ListAccessProfilesOutput"
):
    """Returns the access profiles in a space.

    Args:
        space_id: The unique ID of the space.
        next_token: A token to retrieve the next page of results.
        max_results: The maximum number of access profiles to return per page. Defaults to 100.

    Raises:
        capo_cloudwatchomni.errors.access_denied_exception.AccessDeniedException: The caller is not authorized to perform this action.
        capo_cloudwatchomni.errors.internal_server_exception.InternalServerException: An unexpected error occurred while processing the request.
        capo_cloudwatchomni.errors.resource_not_found_exception.ResourceNotFoundException: The specified resource does not exist.
        capo_cloudwatchomni.errors.throttling_exception.ThrottlingException: The request was throttled due to exceeding the allowed request rate.
        capo_cloudwatchomni.errors.validation_exception.ValidationException: A parameter is specified incorrectly.
        capo_cloudwatchomni.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List access profiles in a space
        The following example lists the first page of access profiles in a space and returns a nextToken to retrieve the next page. Payloads are shown as JSON; on the wire they are CBOR-encoded.

        >>> await client.list_access_profiles(space_id='a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d', max_results=50)
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudwatchomni.types.list_access_profiles_input.ListAccessProfilesInput]",
    ) -> AsyncOperationResponse[
        "capo_cloudwatchomni.types.list_access_profiles_output.ListAccessProfilesOutput"
    ]:
        import capo_cloudwatchomni._operations.cloud_watch_omni_frontend.list_access_profiles

        (
            output,
            http_response,
        ) = await capo_cloudwatchomni._operations.cloud_watch_omni_frontend.list_access_profiles.async_list_access_profiles(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAccessProfiles")
    )
    input_: capo_cloudwatchomni.types.list_access_profiles_input.ListAccessProfilesInput = {
        "space_id": space_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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