Skip to content

list_memberships

list_memberships(
    *,
    config_overrides: Optional[SecurityIRClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> ListMembershipsResponse

Returns the memberships that the calling principal can access.

Parameters:

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

    An optional string that, if supplied, must be copied from the output of a previous call to ListMemberships. When provided in this manner, the API fetches the next page of results.

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

    Request element for ListMemberships to limit the number of responses.

Raises:

Examples:

Invoke ListMemberships

>>> client.list_memberships(max_results=10)
Source code in docs_src/capo_security_ir/_services/security_ir.py
def list_memberships(
    self,
    *,
    config_overrides: Optional[SecurityIRClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> "capo_security_ir.types.list_memberships_response.ListMembershipsResponse":
    """<p>Returns the memberships that the calling principal can access.</p>

    Args:
        next_token: <p>An optional string that, if supplied, must be copied from the output of a previous call to ListMemberships. When provided in this manner, the API fetches the next page of results. </p>
        max_results: <p>Request element for ListMemberships to limit the number of responses.</p>

    Raises:
        capo_security_ir.errors.access_denied_exception.AccessDeniedException: <p/>
        capo_security_ir.errors.conflict_exception.ConflictException: <p/>
        capo_security_ir.errors.internal_server_exception.InternalServerException: <p/>
        capo_security_ir.errors.invalid_token_exception.InvalidTokenException: <p/>
        capo_security_ir.errors.resource_not_found_exception.ResourceNotFoundException: <p/>
        capo_security_ir.errors.security_incident_response_not_active_exception.SecurityIncidentResponseNotActiveException: <p/>
        capo_security_ir.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p/>
        capo_security_ir.errors.throttling_exception.ThrottlingException: <p/>
        capo_security_ir.errors.validation_exception.ValidationException: <p/>
        capo_security_ir.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Invoke ListMemberships

        >>> client.list_memberships(max_results=10)
    """

    def _handler(
        req: "OperationRequest[capo_security_ir.types.list_memberships_request.ListMembershipsRequest]",
    ) -> OperationResponse[
        "capo_security_ir.types.list_memberships_response.ListMembershipsResponse"
    ]:
        import capo_security_ir._operations.security_incident_response.list_memberships

        output, http_response = (
            capo_security_ir._operations.security_incident_response.list_memberships.list_memberships(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMemberships")
    )
    input_: capo_security_ir.types.list_memberships_request.ListMembershipsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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