describe_ip_groups `async` ¶

describe_ip_groups(
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
    group_ids: Optional[IpGroupIdList] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[Limit] = None,
) -> DescribeIpGroupsResult

Describes one or more of your IP access control groups.

Parameters:

group_ids (Optional[IpGroupIdList], default: None ) –

The identifiers of one or more IP access control groups.
next_token (Optional[PaginationToken], default: None ) –

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
max_results (Optional[Limit], default: None ) –

The maximum number of items to return.

Raises:

AccessDeniedException –

The user is not authorized to access a resource.
InvalidParameterValuesException –

One or more parameter values are not valid.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_workspaces/_services/async_work_spaces.py

async def describe_ip_groups(
    self,
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
    group_ids: Optional[
        "capo_workspaces.types.ip_group_id_list.IpGroupIdList"
    ] = None,
    next_token: Optional[
        "capo_workspaces.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional["capo_workspaces.types.limit.Limit"] = None,
) -> "capo_workspaces.types.describe_ip_groups_result.DescribeIpGroupsResult":
    """<p>Describes one or more of your IP access control groups.</p>

    Args:
        group_ids: <p>The identifiers of one or more IP access control groups.</p>
        next_token: <p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>
        max_results: <p>The maximum number of items to return.</p>

    Raises:
        capo_workspaces.errors.access_denied_exception.AccessDeniedException: <p>The user is not authorized to access a resource.</p>
        capo_workspaces.errors.invalid_parameter_values_exception.InvalidParameterValuesException: <p>One or more parameter values are not valid.</p>
        capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_workspaces.types.describe_ip_groups_request.DescribeIpGroupsRequest]",
    ) -> AsyncOperationResponse[
        "capo_workspaces.types.describe_ip_groups_result.DescribeIpGroupsResult"
    ]:
        import capo_workspaces._operations.workspaces_service.describe_ip_groups

        (
            output,
            http_response,
        ) = await capo_workspaces._operations.workspaces_service.describe_ip_groups.async_describe_ip_groups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeIpGroups")
    )
    input_: capo_workspaces.types.describe_ip_groups_request.DescribeIpGroupsRequest = {}
    if group_ids is not None:
        input_["group_ids"] = group_ids
    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

describe_ip_groups async ¶

describe_ip_groups `async` ¶