list_share_invitations async ¶

async def list_share_invitations(
    self,
    *,
    config_overrides: Optional[AsyncWellArchitectedClientConfig] = None,
    workload_name_prefix: Optional[
        "capo_wellarchitected.types.workload_name_prefix.WorkloadNamePrefix"
    ] = None,
    lens_name_prefix: Optional[
        "capo_wellarchitected.types.lens_name_prefix.LensNamePrefix"
    ] = None,
    share_resource_type: Optional[
        "capo_wellarchitected.types.share_resource_type.ShareResourceType"
    ] = None,
    next_token: Optional["capo_wellarchitected.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_wellarchitected.types.max_results.MaxResults"
    ] = None,
    profile_name_prefix: Optional[
        "capo_wellarchitected.types.profile_name_prefix.ProfileNamePrefix"
    ] = None,
    template_name_prefix: Optional[
        "capo_wellarchitected.types.template_name_prefix.TemplateNamePrefix"
    ] = None,
) -> "capo_wellarchitected.types.list_share_invitations_output.ListShareInvitationsOutput":
    """<p>List the share invitations.</p> <p> <code>WorkloadNamePrefix</code>, <code>LensNamePrefix</code>, <code>ProfileNamePrefix</code>, and <code>TemplateNamePrefix</code> are mutually exclusive. Use the parameter that matches your <code>ShareResourceType</code>.</p>

    Args:
        lens_name_prefix: <p>An optional string added to the beginning of each lens name returned in the results.</p>
        share_resource_type: <p>The type of share invitations to be returned.</p>
        max_results: <p>The maximum number of results to return for this request.</p>
        profile_name_prefix: <p>An optional string added to the beginning of each profile name returned in the results.</p>
        template_name_prefix: <p>An optional string added to the beginning of each review template name returned in the results.</p>

    Raises:
        capo_wellarchitected.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_wellarchitected.errors.internal_server_exception.InternalServerException: <p>There is a problem with the Well-Architected Tool API service.</p>
        capo_wellarchitected.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_wellarchitected.errors.validation_exception.ValidationException: <p>The user input is not valid.</p>
        capo_wellarchitected.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_wellarchitected.types.list_share_invitations_input.ListShareInvitationsInput]",
    ) -> AsyncOperationResponse[
        "capo_wellarchitected.types.list_share_invitations_output.ListShareInvitationsOutput"
    ]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.list_share_invitations

        (
            output,
            http_response,
        ) = await capo_wellarchitected._operations.well_architected_api_service_lambda.list_share_invitations.async_list_share_invitations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListShareInvitations")
    )
    input_: capo_wellarchitected.types.list_share_invitations_input.ListShareInvitationsInput = {}
    if workload_name_prefix is not None:
        input_["workload_name_prefix"] = workload_name_prefix
    if lens_name_prefix is not None:
        input_["lens_name_prefix"] = lens_name_prefix
    if share_resource_type is not None:
        input_["share_resource_type"] = share_resource_type
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if profile_name_prefix is not None:
        input_["profile_name_prefix"] = profile_name_prefix
    if template_name_prefix is not None:
        input_["template_name_prefix"] = template_name_prefix

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