Skip to content

start_user_access_tasks

start_user_access_tasks(
    app_bundle_identifier: Identifier,
    email: Email,
    *,
    config_overrides: Optional[AppFabricClientConfig] = None,
) -> StartUserAccessTasksResponse

Starts the tasks to search user access status for a specific email address.

The tasks are stopped when the user access status data is found. The tasks are terminated when the API calls to the application time out.

Parameters:

  • app_bundle_identifier (Identifier) –

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • email (Email) –

    The email address of the target user.

Raises:

Source code in docs_src/capo_appfabric/_services/app_fabric.py
def start_user_access_tasks(
    self,
    app_bundle_identifier: "capo_appfabric.types.identifier.Identifier",
    email: "capo_appfabric.types.email.Email",
    *,
    config_overrides: Optional[AppFabricClientConfig] = None,
) -> "capo_appfabric.types.start_user_access_tasks_response.StartUserAccessTasksResponse":
    """<p>Starts the tasks to search user access status for a specific email address.</p> <p>The tasks are stopped when the user access status data is found. The tasks are terminated when the API calls to the application time out.</p>

    Args:
        app_bundle_identifier: <p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>
        email: <p>The email address of the target user.</p>

    Raises:
        capo_appfabric.errors.access_denied_exception.AccessDeniedException: <p>You are not authorized to perform this operation.</p>
        capo_appfabric.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception, or failure with an internal server.</p>
        capo_appfabric.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_appfabric.errors.throttling_exception.ThrottlingException: <p>The request rate exceeds the limit.</p>
        capo_appfabric.errors.validation_exception.ValidationException: <p>The request has invalid or missing parameters.</p>
        capo_appfabric.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_appfabric.types.start_user_access_tasks_request.StartUserAccessTasksRequest]",
    ) -> OperationResponse[
        "capo_appfabric.types.start_user_access_tasks_response.StartUserAccessTasksResponse"
    ]:
        import capo_appfabric._operations.fabric_front_end_service.start_user_access_tasks

        output, http_response = (
            capo_appfabric._operations.fabric_front_end_service.start_user_access_tasks.start_user_access_tasks(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_appfabric.types.start_user_access_tasks_request.StartUserAccessTasksRequest",
    ) -> dict[str, Any]:
        import capo_appfabric.types.start_user_access_tasks_request

        return (
            capo_appfabric.types.start_user_access_tasks_request.redact_sensitive(
                input_
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("StartUserAccessTasks", redact_input=_redact_input),
    )
    input_: capo_appfabric.types.start_user_access_tasks_request.StartUserAccessTasksRequest = {
        "app_bundle_identifier": app_bundle_identifier,
        "email": email,
    }

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