Lists all memberships resources within the caller's account.
Parameters:
-
next_token
(Optional[PaginationToken], default:
None
)
–
The pagination token that's used to fetch the next set of results.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
-
status
(Optional[MembershipStatus], default:
None
)
–
A filter which will return only memberships in the specified status.
Raises:
Source code in docs_src/capo_cleanrooms/_services/clean_rooms.py
| def list_memberships(
self,
*,
config_overrides: Optional[CleanRoomsClientConfig] = None,
next_token: Optional[
"capo_cleanrooms.types.pagination_token.PaginationToken"
] = None,
max_results: Optional["capo_cleanrooms.types.max_results.MaxResults"] = None,
status: Optional[
"capo_cleanrooms.types.membership_status.MembershipStatus"
] = None,
) -> "capo_cleanrooms.types.list_memberships_output.ListMembershipsOutput":
"""<p>Lists all memberships resources within the caller's account.</p>
Args:
next_token: <p>The pagination token that's used to fetch the next set of results.</p>
max_results: <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p>
status: <p>A filter which will return only memberships in the specified status.</p>
Raises:
capo_cleanrooms.errors.access_denied_exception.AccessDeniedException: <p>Caller does not have sufficient access to perform this action.</p>
capo_cleanrooms.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
capo_cleanrooms.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
capo_cleanrooms.errors.validation_exception.ValidationException: <p>The input fails to satisfy the specified constraints.</p>
capo_cleanrooms.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_cleanrooms.types.list_memberships_input.ListMembershipsInput]",
) -> OperationResponse[
"capo_cleanrooms.types.list_memberships_output.ListMembershipsOutput"
]:
import capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.list_memberships
output, http_response = (
capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.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_cleanrooms.types.list_memberships_input.ListMembershipsInput = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
if status is not None:
input_["status"] = status
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|